windham-high-school / cubeserver-api-python

The Python/Circuitpython version of the data API wrapper for a high-school STEM competition

CubeServer-api-circuitpython

The CircuitPython/CPython version of the data API wrapper for a high-school STEM competition

This is implemented for both CPython (it is assumed the computer is already connected to the access point for this use-case) and CircuitPython (for microcontrollers).

Example code:

from servercom import Connection, Text

print("Connecting to the server...")
connection = Connection()
print("Connected!")

connection.post(Text("Test from CircuitPython!"))

print("Getting status:")
print(connection.get_status())

---

Limitations & Considerations

• This library disables concurrent write protection- If your code stores something to a file, be careful when writing to it while the board is plugged in to avoid corruption!

Testing Status:

MCU	Description
ESP32	Works
ESP8266	Incompatible
Raspi Pico W	Untested

The ESP8266 is currently incompatible with this micropython library due to lack of memory resources for handling the TLS handshake. To use the ESP8266, please use the Arduino C wrapper.

cubeserver-api-python's Issues

Restructure CubeServer-api-python

Code is extremely repetitive

Make Status API's time more useful

Connect the status API's timestamps to timers etc and document

timetools precision is bad on CricuitPython

Make more intuitive errors

Timetools when sync_time hasn't been called,
etc

More Intuitive Packaging

CubeServer-api-python Testing

All functionalities should be extensively tested parallel to the onboarding sessions

• Data Transmission
• Email Sending
• Code Updates
• Time Syncing
• Time Manipulation/Operations (+, -, %, *, /)
• IR Messages (Receiving, parsing, timeouts, etc)

Versioning system

The API wrapper needs to be versioned properly and have releases that state compatibility with different versions of the server.

Expose control of WiFi to the programmer

As of this writing a persistent WiFi connection is maintained rather continuously- allow more control over when a connection is maintained.

Timeout not working in API wrapper

Make posting datapoints better

Avoid wrapper class
e.g. post(Text(my_str)) -> post(my_str)
post(Temperature(temp)) -> post_temp(temp)

Investigate missing timeout lib

Add Battery Level Datapoint to API wrapper

Make db codecs use generic typing

Accept code updates

Accept code updates from server when the api to check for them is used

Add ir Rx code

Make request() method more sensible

https://github.com/Windham-High-School/CubeServer-api-python/blob/v1.3.3/servercom/implementations/circuitpy.py#L373-L378
is from dealing with wifi intermittence issues.
Make better and easier to catch non 2XX HTTP response codes

better Time __repr__

Show as military time

Replace exceptions with booleans

Exception handling is something beginners will have more trouble with.

Email API

Support the (in development) email API of CubeServer (see Cubeserver issue 37)