Skip to content

Commit

Permalink
Added basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
danimtb committed Jan 8, 2019
1 parent c891f78 commit 9e644a2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
pipersense
==========

[![Build Status](https://travis-ci.org/danimtb/pipersense.svg?branch=master)](https://travis-ci.org/danimtb/pipersense)

This is a firmware designed for multisensor devices based on nodemcu V2 board communitacting over Wifi and MQTT communication protocol. The main purpose of this firmware is to perform as best with [Home Assistant](home-assistant.io).

It is designed with these features in mind:
- Simple low coupled clases with all functionality ([esp8266-utils](https://github.com/danimtb/esp8266-utils) -Relay, LED, Button, WifiManager, MqttManager, DataManager (EEPROM)...).
- Easy to use and reusable to create firmware for other devices.
- C++ code and Arduino interface approach (``setup()``, ``loop()``).

It's capabilities are:
- Fast connection to Wifi network and MQTT broker.
- Publish device information and state topics to MQTT at connection start and periodically.
- ArduinoOTA to target devices flashing a new firmware over Wifi.
- Automatic Updates from devices calling an Update Server with new releases.

Supported devices
-----------------

### Nodemcu V2

![nodemcuv2](images/pipersense-wiring.png)

0 comments on commit 9e644a2

Please sign in to comment.