From 668464f229bdfe295ffe8f308e0e0eaafe7bef0d Mon Sep 17 00:00:00 2001 From: Andrey Klimov Date: Tue, 13 Apr 2021 03:07:18 +0300 Subject: [PATCH] Update on v3.0.0 --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2c616f7..5d7118b 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,10 @@ Lighthub allows connecting together: * Contact sensors (switches, buttons etc) * Analog sensors (Leak detectors, Knobs etc) * 1-Wire temperature sensors (up to 20 on single bus) -* Temperature/Humidity/CO2 sensors: DHT22, CS811, HDC1080 +* Temperature/Humidity/CO2 sensors: DHT22, CS811, HDC1080 and any type of Modbus connected devices * Standard nonexpensive Relay board with TTL inputs, [like this](http://ali.pub/2zlosh) to control AC powered lamps, floor heaters, boilers etc * [Standard nonexpensive LED dimmers](http://ali.pub/2zlokp) and [AC DMX-512 dimmers](http://ali.pub/2zlont) -* Modbus RTU devices (Currently, are deployed two types of Modbus devices: AC Dimmer and Ventilation set (Based on [Vacon 10 controller](http://files.danfoss.com/download/Drives/Vacon-10-Quick-Guide-DPD00714F1-UK.pdf)) +* Modbus RTU devices (Currently, possible to control two types of Modbus devices: AC Dimmer and Ventilation set (Based on [Vacon 10 controller](http://files.danfoss.com/download/Drives/Vacon-10-Quick-Guide-DPD00714F1-UK.pdf)) and configure polling of virtually any Modbus device. * Simple DMX wall sensor panel [like this](http://ali.pub/2zlohe) [List of non-expensive compatible components from AliExpress here](http://ppv.alipromo.com/custom/promo.php?hash=pjagwaovaero6vkeabjpkpvy4gznbgkc&landing_id=39661) @@ -22,7 +22,8 @@ Lighthub allows connecting together: ![alt text](docs/LightHubAppDiagram.png "LightHub application diagram") -Where is possible both, to configure local control/mapping between inputs and outputs (light, floor heating thermostats) and remote control from MQTT enabled software. At the moment, LightHub tested and perfectly working with following set of complementary free software: +Where is possible both, to configure local control/mapping between inputs and outputs (light, floor heating thermostats) and remote control from MQTT enabled software and between controllers. At the moment, LightHub tested and perfectly working with following set of complementary free software: +* [HomeAssistant](https://www.home-assistant.io) - the best choice of HomeAutomation system * [Openhab or Openhab2 Smarthome software](http://www.openhab.org/) Openhab provides own native mobile app both, for IoS and Android, and even allow you to use Apple's HomeKit and Google Home to say "Siri, turn on light in bedroom" or "Hey Google, set bedroom light to Red" but requires some server to be installed in-premises (Raspberry PI with [Openhabian](https://docs.openhab.org/installation/openhabian) will good enough) * [HomeRemote mobile client](http://thehomeremote.com/) @@ -32,11 +33,13 @@ Home Remote mobile applicatios for IoS and Android requires just MQTT broker to Scalability of Lighthub is virtually unlimited: Setup so many controllers you needed in most convenient places of your house - MQTT broker will allow controllers communicate each other and with Openhab/NodeRed/HomeRemote and propagate commands across network. # [Please refer to our Wiki for insructions.](https://github.com/anklimov/lighthub/wiki/Configuring) +* [Russian-language Wiki](https://www.lazyhome.ru/dokuwiki/doku.php) * [Compiling and flashing](https://github.com/anklimov/lighthub/wiki/Compiling-and-flashing) * [Configuring](https://github.com/anklimov/lighthub/wiki/Configuring) * [Channel commands](https://github.com/anklimov/lighthub/wiki/Channel-commands) * [OpenHab integration](https://github.com/anklimov/lighthub/wiki/OpenHab--integration) - +* [Doxygen developers documentation](https://anklimov.github.io/lighthub/docs/html/index.html) +* [Latest Release notes](https://github.com/anklimov/lighthub/releases/tag/v3.0.0) # Platforms specific details: @@ -55,7 +58,7 @@ Scalability of Lighthub is virtually unlimited: Setup so many controllers you ne **ESP8266, ESP32**: (Tested) * DMX-OUT on USART1 TX * DMX-IN - disabled - not possible to deploy in ESP8266 -* Modbus - disabled. Might be configured in future on USART0 instead CLI/DEBUG +* Modbus - disabled on ESP8266, Might be configured in future on USART0 instead CLI/DEBUG, on ESP32 binded with UART2 * Uses Wifi interface instead wired connection **NRF52840** : Still early development stage @@ -67,11 +70,14 @@ Scalability of Lighthub is virtually unlimited: Setup so many controllers you ne * USE_1W_PIN=49 // use direct connection to 1W devices on 49 pin, no I2C bridge DS2482-100 * SD_CARD_INSERTED // enable sd-card support and fix lan starting * SERIAL_BAUD=115200 // set baud rate for console on Serial0 -* Wiz5500 //Use Wiznet 5500 library instead Wiznet 5100 +* Wiz5500 //Use Wiznet 5500 library instead universal Wiznet +* Wiz5100 //Use Wiznet 5500 library instead universal Wiznet * DISABLE_FREERAM_PRINT // disable printing free Ram in bytes * CUSTOM_FIRMWARE_MAC=de:ad:be:ef:fe:00 //set firmware macaddress * DMX_DISABLE //disable DMX support -* MODBUS_DISABLE // disable Modbus support +* MODBUS_DISABLE // disable old Modbus driver +* MBUS_DISABLE // disable new Modbus driver +* MODBUS_TX_PIN=13 * OWIRE_DISABLE // disable OneWire support * ARTNET_ENABLE //Enable Artnet protocol support * AVR_DMXOUT_PIN=18 // Set Pin for DMXOUT on megaatmega2560 @@ -82,11 +88,27 @@ Scalability of Lighthub is virtually unlimited: Setup so many controllers you ne * WIFI_MANAGER_DISABLE //Disable wifi manager for esp8266 * COUNTER_DISABLE //disable Counter, Uptime input support (for RAM savings on mega2560) * DHT_DISABLE //disable DHT input support (for RAM savings on mega2560) +* PID_DISABLE // Disable PID regulator +* STATUSLED // Enable RGB status led on pins 50,51,52 (DUE only) +* DMX_SMOOTH //Smooth transition on DMX channels (DUE only) +* OTA // Enable Other The Air firmware upload +* W5500_CS_PIN=53 //Defines CS pin for Ethernet adapter (10-th by default) +* WIFI_ENABLE //Enable WiFi for ESP (Wiznet by default) +* SPILED_DISABLE //Disable SPI LED library +* AC_DISABLE //Disable UART Hayer Air condition driver +* M5STACK //Logging to M5Stack OLED screen +* NO_HOMIE //Disable HOMIE discovery topics +* BRIGHT_STEP //Scale DMX bright - Table1 +* BRIGHT_LOG //Scale DMX bright - Table2 +* MCP23017 allow I2C input port extender on MCP23017 chip * RESTART_LAN_ON_MQTT_ERRORS //reinit LAN if many mqtt errors occured * DEVICE_NAME short handy device name which is used instead of mac for download config http://{MY_CONFIG_SERVER}/{DEVICE_NAME}_config.json * SYSLOG_ENABLE enable UDP SYSLOG support feature(under DEVELOPMENT) that must be configured through config file * WITH_PRINTEX_LIB use PrintEx library (develop experimental feature) * CSSHDC_DISABLE //Disable CS811 and HDC1080 sensors support +* FASTLED - using FASTLED library instead default ADAFRUIT_LED +* SCALE_VOLUME_100 using 0..100 scaling in /set topics instead 0.255 (default) +