Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 3.09 KB

README.md

File metadata and controls

25 lines (17 loc) · 3.09 KB

IOTConnect

Version Build Status Codacy Badge License GitHub last commit GitHub commit activity

Extensible Internet Of Things integration service written in Python that can be run in a Raspberry Pi Zero W.

It monitors the data from all configured monitors and publish the gathered data to all configured publishers.

This repo is an evolution and an extensible version of Pioniq.

Features

  • Connectivity: Connect anything that can be monitored using python with your IOT hub using built in MQTTPublisher.
  • Customization: More systems and information can be monitored and published developing additional Monitors and Publishers.
  • Open-source: You are welcome to improve the service by fixing bugs, adding functionality or developing your own Monitors and Publishers and make a pull request.

Documentation

Available at https://hokus15.github.io/IOTConnect/. Note that documentation is still under construction...

To learn how to install and configure from scratch IOTConnect in a RaspberryPi Zero W and read OBDII data from a Hyundai Ioniq EV 28kWh and including the GPS position and publish the data to a MQTT broker you can follow the turorial.

Informal disclaimer

I'm a noob in python programming and I'm not a Linux expert so I'm pretty sure that the source code may be far from efficient, so don't be too hard with me if you find that I'm not following best practices neither doing things in the most optimal way. If you find that anything that can be improved (I'm sure it is), just raise a PR with your improvements or contact me.

Disclaimer

IOTConnect (“THE SOFTWARE”) IS PROVIDED AS IS. USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHOR MAKE NO WARRANTIES AS TO PERFORMANCE OR FITNESS FOR A PARTICULAR PURPOSE, OR ANY OTHER WARRANTIES WHETHER EXPRESSED OR IMPLIED. NO ORAL OR WRITTEN COMMUNICATION FROM OR INFORMATION PROVIDED BY THE AUTHORS SHALL CREATE A WARRANTY. UNDER NO CIRCUMSTANCES SHALL THE AUTHORS BE LIABLE FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES RESULTING FROM THE USE, MISUSE, OR INABILITY TO USE THE SOFTWARE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. THESE EXCLUSIONS AND LIMITATIONS MAY NOT APPLY IN ALL JURISDICTIONS. YOU MAY HAVE ADDITIONAL RIGHTS AND SOME OF THESE LIMITATIONS MAY NOT APPLY TO YOU. THIS SOFTWARE IS ONLY INTENDED FOR SCIENTIFIC USAGE.