Remote Sensors API protocol library
This library translates raw bytearrays into the Remote Sensors API models.
This implementation uses the XBee Python library. And translates the incoming device messages into a Remote Sensors Request and Response.
This library uses similar syntax than Sanic or Flask.
Usage
import remote_sensors
from digi.xbee.devices import XBeeDevice
import my_settings as settings
@remote_sensors.bind_to_device()
@remote_sensors.request()
def access_log(request: remote_sensors.Request, *args, **kwargs):
"""Simple Access Logger method."""
logger.info(f'Request: {request.method} - {request.uri}')
@remote_sensors.bind_to_device()
@remote_sensors.request(method='REGISTRATION')
def handle_registration(request: remote_sensors.Request, *args, **kwargs):
"""Handles the registration request."""
response = remote_sensors.Response(status='ACK',
transaction=request.transaction)
# do something about it :D
payload = {
'request': request.as_dict(),
'response': response.as_dict(),
'completed': False,
}
logger.debug(f'Replying with {response.status} to {sensor_message.addresses}')
# send the response to the device
return response
@remote_sensors.bind_to_device()
@remote_sensors.request(method='END_REGISTRATION', pass_message=True)
def handle_registration_end(request: remote_sensors.Request, sensor_message: remote_sensors.SensorRequest,
*args, **kwargs):
"""Handles the end of registration."""
response = remote_sensors.Response(status='ACK',
transaction=request.transaction)
# do something about it :D
payload = {
'device': sensor_message.as_dict(),
'request': request.as_dict(),
'response': response.as_dict(),
'completed': True,
}
logger.debug(f'Device ({sensor_message.addresses}) has finished registration')
return response
device = XBeeDevice(settings.SERIAL_PORT, settings.BAUD_RATE)
def main():
device.open()
remote_sensors.app.init(device)
while True:
time.sleep(1)
if __name__ == '__main__':
try:
main()
finally:
if device.is_open():
device.close()
Contact
Arnulfo Solis Ramirez
Metadata
Release files for remote-sensors 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| remote_sensors-0.1.1.tar.gz | 10.2 kB | Without provenance | Details for remote_sensors-0.1.1.tar.gz |
Release files / remote_sensors-0.1.1.tar.gz
| Download URL | remote_sensors-0.1.1.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c14527128a52b58820a5b59419a1a39721177920bca11bf609db42970389fe1
|
|
BLAKE2b-256 checksum How to use checksums |
2a4986a77550836d56bab788331624b6a4bf96603c7a1ec34849ea6c8c260c8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0
|
Security for remote-sensors 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.