Package: apd.sensors
Advanced Python Development SensorsThis is the data collection package that forms part of the running example
for the bookAdvanced Python Development.UsageThis installs a console script calledsensorsthat returns a report on
various aspects of the system. The available sensors are:Python versionIP AddressesCPU UsageRAM AvailableBattery charging stateAmbient TemperatureAmbient HumidityThere are no command-line options, to view the report runsensorson the
command line.CaveatsThe Ambient Temperature and Ambient Humidity sensors are only available on
RaspberryPi hosts and assume that a DHT22 sensor is connected to pinD20.The location and type of the sensor can be controlled by setting a pair of
environment variables:APD_SENSORS_TEMPERATURE_BOARDandAPD_SENSORS_TEMPERATURE_PIN.If there is an entry in/etc/hostsfor the current machine's hostname that
value will be the only result from the IP Addresses sensor.InstallationYou can install withpip3 install apd.sensorsunder Python 3.7 or higher.We recommend using pipenv to manage your environment, in which case you would
install usingpipenv --three install apd.sensorsand run the programme usingpipenv run sensors.API serverThere is an optional API server shipped with apd.sensors. To use this you
should install theapd.sensors[webapp]extra. The API can then be started
with the non-production quality wsgiref server using:python -m apd.sensors.wsgi.serveor through Waitress (if installed) using:waitress-serve --call apd.sensors.wsgi:set_up_configOther WSGI servers will also work, you should use set_up_config as a factory
function.An environment variable is required to use the API server,APD_SENSORS_API_KEYshould be set to the API key required to gain access. One can be generated
using:python -c "import uuid; print(uuid.uuid4().hex)"The following endpoints are supported:/v/3.0/sensors/v/3.0/sensors/sensorid/v/3.0/deployment_idHistorical dataYou can install optional functionality to periodically store sensor
values using theapd.sensors[scheduled]extra. In this case,sensors --savewill store the recorded data tosensor_data.sqlitein the current working directory.The database connection can be specified with--db sqlite:////var/sensors.sqlite,
for example. It can also be specified with theAPD_SENSORS_DB_URIenvironment variable.The database must be migrated to contain the correct data first. This can be
done by runningalembic upgrade headwith the following alembic.ini file
in the current working directory.[alembic]
script_location = apd.sensors:alembic
sqlalchemy.url = sqlite:///sensor_data.sqliteHistorical data APIAn API to extract historical data is also available if installed withapd.sensors[webapp,scheduled,storedapi].This provides the following three URIs, where start and end are a date/time in ISO format./v/3.0/historical/v/3.0/historical/start/v/3.0/historical/start/endChanges2.2.1 (2020-05-21)Unexpected errors from sensors should not cause a 500 error in the v3 API (Matthew Wilkes)2.2 (2020-01-17)Add ability to store data points on query (Matthew Wilkes)Add v3.0 API to distinguish sensor errors and include historical data (Matthew Wilkes)2.1.1 (2020-01-06)Cache DHT sensor connections (Matthew Wilkes)Force use of bitbang interface for DHT sensors, to improve reliability on Linux (Matthew Wilkes)2.1.0 (2019-12-09)Add optional APD_SENSORS_DEPLOYMENT_ID parameter and v2.1 API which allows
users to find a unique identifier for a webapp sensor deployment (Matthew Wilkes)2.0.0 (2019-09-08)Addto_json_compatibleandfrom_json_compatiblemethods to Sensor
to facilitate better HTTP API (Matthew Wilkes)HTTP API is now versioned. The API from 1.3.0 is available at /v/1.0
and an updated version is at /v/2.0 (Matthew Wilkes)1.3.0 (2019-08-20)WSGI HTTP API support added (Matthew Wilkes)1.2.0 (2019-08-05)Add external plugin support throughapd.sensors.sensorsentrypoint (Matthew Wilkes)1.1.0 (2019-07-12)Add --develop argument (Matthew Wilkes)1.0.1 (2019-06-20)Fix broken 1.0.0 release (Matthew Wilkes)1.0.0 (2019-06-20)Added initial sensors (Matthew Wilkes)Copyright (c) 2019 Matthew WilkesPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.