Skip to main content

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

Release files for spymarine 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spymarine 0.7.0
File Size Uploaded
spymarine-0.7.0.tar.gz 33.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for spymarine 0.7.0
File Interpreter ABI Platform
spymarine-0.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 45.0 kB

Release files / spymarine-0.7.0.tar.gz

Download URL spymarine-0.7.0.tar.gz
Size 33.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a3c7761c2c729d1f1f6089ab8e90c5dba51b8b7b14d38b7ceed03c810730119a
BLAKE2b-256 checksum
How to use checksums
42bc4bb90b58442b5e884abf040c622099623532b1c2d23fd162bbff049de9c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.11

Release files / spymarine-0.7.0-py3-none-any.whl

Download URL spymarine-0.7.0-py3-none-any.whl
Size 12.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e11336d8c4d566f04de22596bacf930b6203f53f177318ea8d358613bd7aac94
BLAKE2b-256 checksum
How to use checksums
e1ec75116bdfa2ca8592c85fcf820488dc6e21754298f48cf69d8d8cb9a4674e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.11

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2

2 release files

0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page