Skip to main content

Communicate with Simarine devices using asyncio and Python

Project description

spymarine

A library for spying on Simarine devices and their sensor values using asyncio and Python

Based on the fantastic reverse engineering work of https://github.com/htool/pico2signalk

Only tested with Simarine Pico rev2 and firmware 1.17

Library Installation

pip install spymarine

Getting Started

Make sure your Simarine device is configured to use AP or STA Wifi mode. It's not possible to connect via a local network while in REMOTE mode.

Run the following code on the same network that the Simarine device is connected to:

import asyncio
import spymarine

async def main():
    # Print all devices and their latest sensor values every second
    async with spymarine.DeviceReader() as reader:
        while True:
            await reader.read_sensors()
            print(reader.devices)
            await asyncio.sleep(1)

if __name__ == "__main__":
    asyncio.run(main())

Troubleshooting

Q: DeviceReader is stuck while establishing a connection when using STA Wifi mode

  • Update the Pico's firmware

Known Issues

  • Non-ASCII characters in device names will not be represented correctly and replaced with a placeholder. A non-standard encoding seems to be used.

Reporting issues

  • Run tools/make-debug-report.py
  • Create a new issue on GitHub and attach the debug.log

Author

Christopher Strack

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spymarine-0.6.2.tar.gz (35.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spymarine-0.6.2-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file spymarine-0.6.2.tar.gz.

File metadata

  • Download URL: spymarine-0.6.2.tar.gz
  • Upload date:
  • Size: 35.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for spymarine-0.6.2.tar.gz
Algorithm Hash digest
SHA256 4fbd5a09f9fc10129d1ef4ebd97e60aeef9d0457867b5593c9c9711aad463ced
MD5 030952c04200bca78066235f415aa4e2
BLAKE2b-256 51c0d1e00c3b28b746705b584d9a05733d06177e760a95883a2f1e9d2cf2911f

See more details on using hashes here.

File details

Details for the file spymarine-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: spymarine-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 11.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for spymarine-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 84bdce003e402304d226d959bfa52812b30e37f92ef7560eba807e68899d7056
MD5 01f0142bdcb9258dc66313ba96890121
BLAKE2b-256 8c4d1324cb64712a6088626a799ab2512577e15422bc8f806bf18231d7b34c2b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page