Metadata-Version: 2.1
Name: spymarine
Version: 0.2.1
Summary: Communicate with Simarine devices using asyncio and Python
Home-page: https://github.com/christopher-strack/spymarine
License: MIT
Author: Christopher Strack
Author-email: christopher.strack@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Bug Tracker, https://github.com/christopher-strack/spymarine/issues
Project-URL: Documentation, https://github.com/christopher-strack/spymarine/tree/main#readme
Project-URL: Repository, https://github.com/christopher-strack/spymarine
Description-Content-Type: text/markdown

# 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

## Library Installation

```sh
pip install spymarine
```

## Getting Started

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

```python
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())
```

## Author

Christopher Strack

