https://github.com/ricco386/rpi.sensor

Generic Python base class to create infinite loop to work with different sensors connected to Raspberry Pi. Project contains also extended Python base class with MQTT support.
https://github.com/ricco386/rpi.sensor

gpio library mqtt raspberrypi rpi sensors

Last synced: about 1 month ago
JSON representation

Generic Python base class to create infinite loop to work with different sensors connected to Raspberry Pi. Project contains also extended Python base class with MQTT support.

• Host: GitHub
• URL: https://github.com/ricco386/rpi.sensor
• Owner: ricco386
• License: mit
• Created: 2020-01-01T16:13:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-12-13T17:13:32.000Z (almost 3 years ago)
• Last Synced: 2024-10-02T05:01:59.809Z (about 2 months ago)
• Topics: gpio, library, mqtt, raspberrypi, rpi, sensors
• Language: Python
• Homepage:
• Size: 52.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Security: SECURITY.rst

Awesome Lists containing this project

README

        
RPi.Sensor

##########

.. image:: https://github.com/ricco386/RPi.Sensor/workflows/Test%20RPi.Sensor%20codebase/badge.svg

.. image:: https://github.com/ricco386/RPi.Sensor/workflows/Release%20RPi.Sensor%20to%20PyPI/badge.svg

Generic Python base class to create infinite loop to work with different sensors connected to Raspberry Pi. Project

contains also extended Python base class with MQTT support.

RPi.Sensor library is stable in terms of running as a base class. Sensor logic and additional functionality before and

after sensor measurement should be implemented in child objects anyway... But there are new features developed (and

bug fixed as they are found) so it is recommended always use the latest version.

If you want to see example of implemented sensors, have a look at my other `RPi repo `_.

Installation

------------

- Install the latest released version using pip::

    pip install https://github.com/ricco386/RPi.Sensor/zipball/master

- Alternatively install latest released version from pypi::

    pip install --upgrade RPi.Sensor

- Make sure all dependencies (listed below) are installed (done automatically when installing via pip)

**Dependencies:**

- `RPi.GPIO `_

- `wheel `_

- `paho-mqtt `_

Usage

-----

Inherit Sensor object or MqttSensor.

Main purpose of the sensor object is to run infinite loop for reading from the sensors. Object has build in basic

functionality to terminate the infinite loop correctly (uppon CTRL+C or kill signal), basic logging etc.

Intention is to have ability to easily run some code before (or after) reading the sensor, this is is skeleton that

doesnt do any logic and should be used only as a base for building the interactions with the sensors.

If you want to see example of implemented sensors, have a look at my other `RPi repo `_.

If you find a security vulnerability please read through

`SECURITY.rst `_ file and report it responsibly. All

other issues and feature requests report via `Github issue tracker `_.

License

-------

For more information see the `LICENSE `_ file.