cuplcodec 2.1.0

Package for creating and decoding URLs that contain temperature and humidity samples.

cuplcodec

cuplcodec encodes environmental sensor data into a URL. Each sample includes two 12-bit readings (temperature and humidity). These are converted to base64 and written into a circular buffer. A HMAC is written after the most recent sample in the buffer. The URL can be rendered as a QR code or stored on an NFC tag. If a tag with a URL is tapped by a mobile phone, it opens automatically in a web browser. This allows the user to view sensor data without installing an app on their phones. A web application comprising cuplfrontend and cuplbackend runs the decoder in cuplcodec, unwraps the circular buffer and displays a list of samples in the browser.

Tests

The codec is tested with pytest. The encoder written in C can be tested with the decoder written in Python using CFFI.

Documentation

Hosted on ReadTheDocs. This includes information on how to run the encoder on an MSP430.

PyPI Package

Hosted on PyPI. Install the package with:

pip install cuplcodec

Licence

cuplcodec

Documentation