Updated Spice API (markdown)

sp2xdev
2025-04-14 17:55:39 -07:00
parent 0ab18fda5f
commit ba341e3113
+3 -1
@@ -1,4 +1,6 @@
Spice API is documented in https://github.com/spice2x/spice2x.github.io/tree/main/src/spice2x#api - Arduino, C++, Dart, and Python implementations are provided. Sample client code is located here: [samples](https://github.com/spice2x/spice2x.github.io/tree/main/src/spice2x/api/resources). Python is the only client library that has complete implementation of the API; other languages will have gaps. Please feel free to submit a PR to update them if you end up adding code.
Spice API is documented in https://github.com/spice2x/spice2x.github.io/tree/main/src/spice2x#api.
Arduino, C++, Dart, and Python wrapper implementations are provided. Sample client code is located here: [samples](https://github.com/spice2x/spice2x.github.io/tree/main/src/spice2x/api/resources). Python is the only client library that has complete implementation of the API; other languages will have gaps. Please feel free to submit a PR to update them if you end up adding code.
Additionally, API is also available over serial (`API Serial Port (-apiserial)` option) and over [WebSocket](https://github.com/spice2x/spice2x.github.io/tree/main/src/spice2x/api/resources/dart/spiceapi-websocket).