Compare commits

...

202 Commits

Author SHA1 Message Date
feee8c2fe0 update mode of operation documentation for oil sensor 2025-10-17 09:06:18 +02:00
671a9b8487 updated documentation to include ESP8266 2025-10-17 09:06:18 +02:00
96af098d3f update json template to avoid warning in HA 2025-10-16 21:47:09 +02:00
c2c5bb34e7 Merge branch 'small-improvements' 2025-10-11 16:59:06 +02:00
0998f815fd set entity_id on HA side for all switches - keep the id consistent, regardless of the name or where it is used 2025-10-11 16:58:20 +02:00
b4d4a179f1 use easy switch for external router 2025-10-11 16:58:20 +02:00
ccfa0f427a EasyHomeSwitch: separate codes for all buttons because they common to all switches and thus the same across all class instances 2025-10-11 16:58:20 +02:00
ecac0a3d81 supress cppcheck false warnings 2025-10-11 16:58:20 +02:00
55213b9e87 use standard fixed length types 2025-10-11 16:58:20 +02:00
4f9c91c108 update static check options and fix lows 2025-10-11 16:58:20 +02:00
1eddcd1f5c enable all flags for huzzah_dev so that compilation for the entire code can be verified 2025-10-11 16:58:20 +02:00
bfd8b02f2a upgrade to ha-mqtt v2.0.0 2025-10-11 16:57:52 +02:00
04b2d1c306 Merge branch 'rc-devices' 2025-10-08 16:19:33 +02:00
545a6fd2f6 reduce memory usage by using string for battery percentage template
defined at compile time
2025-10-06 18:39:51 +02:00
3dc31ff585 optimize memory allocation for battery percentage template 2025-10-06 18:39:51 +02:00
57b9494c98 add helper methods for creating typical battery sensors for rc devices 2025-10-06 18:39:51 +02:00
0a228df07d create rc devices typical battery sensors 2025-10-06 18:39:51 +02:00
264c1c1e80 separate rc-gateway devices 2025-10-06 18:39:51 +02:00
daa4b9bee0 add Wifi info 2025-10-06 18:39:14 +02:00
01a0741a0c Merge branch 'presence_sensor' 2025-10-06 18:37:52 +02:00
7a220bcc38 fix bug where voltage was sent every 6 minutes instead of 6 hours 2025-10-05 09:49:54 +02:00
346483c43c renamed project 2025-10-03 11:02:59 +02:00
475a58d8a4 upgrade ha-mqtt to v1.12 that changed path for state and command topics 2025-10-03 10:58:19 +02:00
6edcafe27c adjust battery percent formula: max 3.3V and min 2.7V (the minimum voltage required by ATTiny85) 2025-10-03 10:58:14 +02:00
7c9678a57c fix bug where voltage is always sent 2025-10-02 17:12:29 +02:00
82df106df1 use uppercase ON/OFF when reading contact sensor type - it aligns with home assistant 2025-10-02 16:57:02 +02:00
f245443a4d add presence sensor into rc-gateway 2025-10-02 16:57:02 +02:00
77422d5f59 use wrapper class for SensorId and overload operators so that it can be used both as number and string 2025-10-02 16:56:52 +02:00
4ea9c83ff9 add test for max value 2025-10-02 16:42:43 +02:00
4ab725a59e create presence sensor device 2025-10-01 18:11:39 +02:00
d22bb8910b add license 2025-09-20 11:48:21 +02:00
9141c0478c Merge branch 're-organize' 2025-09-20 10:55:12 +02:00
10c20392db move libraries into lib folder which is platformio specific 2025-09-20 10:38:53 +02:00
1d8ad30c5b use LFS for images and Fritzing files 2025-09-20 10:29:08 +02:00
89da9a80e8 re-organize:
- move code for all devices in dedicated folder
- move code for gateway in the root folder
2025-09-20 10:00:42 +02:00
bd53ec9837 remove unused/redundant libraries:
- orphan .gitmodule for RF24
- Adafruit-GFX-Library-Tiny v1.2.2: it is the same as the official version of the same version
- Adafruit_LED_Backpack-Tiny v1.1.6: the only difference it is the
  inclusion of TinyWireM.h instead of Wire.h
2025-09-18 12:05:25 +02:00
25db98e0f3 update ha-mqtt libarary after ha-webserver was merged into it 2025-09-10 14:16:15 +02:00
ac9e485ce0 upgrade libraries - return list of commands as json 2025-09-08 14:13:21 +02:00
6bfa3c11c3 update webserver library which uses for better compatibility to REST specs 2025-09-07 10:26:37 +02:00
80b0509689 Merge branch 'webserver' 2025-09-06 22:06:22 +02:00
e80b4090e6 use web server from library 2025-09-06 22:05:47 +02:00
9fa610c7bf add support for web server 2025-08-05 20:40:30 +02:00
10721cfe52 added homebox in the switch list and change switch from fritzbox to kabelbox 2025-07-13 11:59:18 +02:00
7720f8a7c1 updated percent calculation for oil tank battery after minimum voltage observed was 4,04 2025-06-20 11:33:07 +02:00
7258ab9b56 no need to have OilTank namespace since it has only one sensor 2025-06-20 11:33:07 +02:00
ff53fa9831 add long term statistics for oil level and depth 2025-06-20 11:32:56 +02:00
0a7554d843 fix bug when generating mqtt configuration - a secondary component must have a device_class otherwise it will override the main component configuration 2025-06-07 10:41:59 +02:00
4e12ca89eb use common restart button 2025-03-27 12:31:02 +01:00
67313b22c8 add icon for restart button 2025-03-26 14:26:54 +01:00
a7759a7c07 add icon for oil tank level 2025-03-26 10:29:36 +01:00
95e6d408b3 make "meeting sensor" switch generic 2025-01-16 18:03:10 +01:00
d123f08181 add flag to disable doorbell 2024-12-02 09:11:59 +01:00
ed5723e356 cleanup gitignore 2024-10-15 17:33:15 +02:00
3f00d8c506 upgrade to ha-mqtt 1.3.0 and add included diagnostic sensors 2024-10-15 17:15:15 +02:00
a25746cfc9 Merge branch 'switches-default-name' 2024-10-15 17:12:55 +02:00
247e0fbb37 generate default name for easy home switches 2024-10-07 14:12:52 +02:00
36f96bb9a1 use generic name for easy_home_b switch 2024-10-05 21:30:27 +02:00
996683d43c use string as a pointer to keep the reference to id 2024-10-05 21:29:52 +02:00
e246158502 build a default name for Pollin switches 2024-10-05 21:28:54 +02:00
7e44a0710a make name optional for PollinSwitch 2024-10-05 11:02:47 +02:00
72aa6749cd add explicit dependecy on TaskScheduler (used in both wifi and ha-mqtt libraries) and upgrade to 3.8.5 2024-10-04 18:31:55 +02:00
fa4c085b32 fix battery percent by using value_json as input 2024-07-07 18:05:53 +02:00
81b36f271e switch to wifi v2.0.0 - without multiple SSIDs 2024-06-30 00:56:43 +02:00
758cc52b16 fix issue with wifi and mqtt reconnection 2024-06-29 17:37:27 +02:00
a68b9b4971 add support for command line reset 2024-06-29 13:37:22 +02:00
5ef715227d add switch for bedroom player - Tivoli 2024-06-16 12:16:32 +02:00
5fccc50c1e update calculation for oil tank 2024-06-16 12:09:20 +02:00
9141c8d54e update my libraries and switch to using wifi lib 2024-06-04 21:07:52 +02:00
004bba0175 fix decoder tests 2024-06-04 21:02:38 +02:00
d96d4cc666 Merge branch 'huzzah' 2024-05-30 12:45:09 +02:00
2411750b35 use chars for protocol 1 group, with leading 0, to match the way is defined in devices 2024-05-30 12:16:28 +02:00
cad27ea106 Merge branch 'library' into huzzah 2024-05-30 08:32:38 +02:00
3a19576b51 turn into ha-mqtt library 2024-05-30 08:30:23 +02:00
510a378a5e add Number, refactor StateConfig and add support for restoring state at startup 2024-05-29 16:13:01 +02:00
1fe24a5b7f add support for setting retain 2024-05-29 16:09:54 +02:00
b4daba4cb2 rename secondary entities and add support for configuration type entity 2024-05-29 16:08:05 +02:00
ce21dedcd5 generic support for using device's name 2024-05-29 16:01:00 +02:00
c03c3d03fd decouple mqtt:
- register onConnected and onDisconnected callbacks
- allow optional Scheduler
- publishInit is independent on Scheduler
2024-05-22 13:42:52 +02:00
4693969aff reorganize platformio.ini configuration 2024-05-22 00:04:21 +02:00
a4893747bb moved temp sensor next to servers 2024-05-21 01:15:56 +02:00
795772909f Merge branch 'protocol' into huzzah 2024-05-20 22:00:27 +02:00
c2395e8bde switch back to returning pointer in findProtocol - only this works with derived classes 2024-05-20 22:00:09 +02:00
f668beeca2 use enum for protocol 2024-05-20 17:57:32 +02:00
45e0ea3261 use constexpr and dedicated protocol class 2024-05-20 17:57:07 +02:00
f8eb28786a pro-mini doesn't support map, find protocol based on each protocol's value - type safe 2024-05-20 13:19:41 +02:00
4096bfc83a Merge branch 'doorbell' into huzzah 2024-05-19 18:11:28 +02:00
b140fd08ac find protocol based on dynamically created map 2024-05-19 17:50:26 +02:00
1d99c73bdf use map to find sensors 2024-05-19 11:50:19 +02:00
6733a6678a use better names for constructing secondary entities 2024-05-19 01:33:11 +02:00
8282af3992 use reference when building DeviceConfig 2024-05-19 01:31:41 +02:00
2706b6f1a5 allow creation of DeviceConfig only with factory method 2024-05-18 22:44:36 +02:00
e9c404a4d5 add doorbell protocol 2024-05-18 21:17:23 +02:00
3152375623 pin definitions in a dedicated file 2024-05-18 20:42:05 +02:00
d665b12c71 update PINs for final connectivity 2024-05-18 13:43:46 +02:00
ddbefdae5d use blue led to indicate mqtt connectivity 2024-05-18 09:45:17 +02:00
22add7aea8 move all devices creattion in devices.h 2024-05-17 18:01:12 +02:00
4b3ed383d8 destroy container along with the builders 2024-05-17 09:26:35 +02:00
a44b890d43 Merge branch 'refactor' into huzzah 2024-05-16 17:27:24 +02:00
3d7895e916 fine tunning:
- use namespace for oil tank builders
- use factory method for creating DeviceConfig
- use C's strcmp for comparing strings
- split parsing of incoming RCSwitch states
2024-05-16 11:14:47 +02:00
77594581ff return string when building protocol ids - avoid unused pointers 2024-05-16 10:26:15 +02:00
b5e13c9ba2 uniqueId, configTopic & commandTopic:
- for sensors, use deviceClass as part of uniqueId & configTopic
- use same commandTopic for all Commands - with /set at the end
2024-05-16 10:13:36 +02:00
6ebe06344c use same Builder for sensor specific fields 2024-05-16 10:05:24 +02:00
44d14d9a09 cleanup 2024-05-16 09:53:55 +02:00
1b438fb141 move config publishing inside Component 2024-05-15 10:33:09 +02:00
f2e3e1940e destroy builders 2024-05-15 10:28:39 +02:00
6a287007d7 unify execution of containers inside the list 2024-05-15 10:28:35 +02:00
ae525d7e15 unify Commands and use map to trigger onCommand 2024-05-15 08:04:21 +02:00
7b53efe1ca use Builder instead of EntityConfig 2024-05-15 00:53:38 +02:00
ee87deb2d0 disable retain for command mesages 2024-05-14 08:05:08 +02:00
333fc93a9f move area completely under DeviceConfig 2024-05-09 13:46:22 +02:00
965e158b6a add oil tank sensor 2024-05-09 11:52:40 +02:00
6fd9bdc8ce added oil tank room sensor 2024-05-04 21:46:39 +02:00
18450a6883 fix on/off map insertion 2024-05-04 16:17:43 +02:00
7a6caf6afe use sensor name for the device 2024-05-03 17:19:52 +02:00
f6fed5a115 publish sensor configuration 2024-05-03 13:56:29 +02:00
278d82dec6 fix random resets by initializing all pointers with nullptr 2024-05-03 13:55:19 +02:00
1e69ecd9c9 publish config from list of all components 2024-05-03 13:50:13 +02:00
86b2d75ea6 separate generic Ha components - could be used in a library 2024-05-03 09:22:53 +02:00
e67ce3b33c extract StateConfig into a dedicated class 2024-05-02 21:24:41 +02:00
eace33902b separate Ha generic components from gateway specific ones 2024-05-02 19:40:04 +02:00
551c1300a6 publish cleanup config on OTA updates 2024-05-02 18:56:52 +02:00
071e363c14 make publisher accesible to entire Ha namespace 2024-05-02 12:44:30 +02:00
6b37d61b5c unify switches under same list and get rid of Builder 2024-04-30 23:08:22 +02:00
a9d66e29e3 fix on/off all switches 2024-04-30 21:27:02 +02:00
aaeb0a85e6 add support for reacting on switching on/off all EasyHome switches 2024-04-30 16:23:54 +02:00
9611b2c564 support state for EasyHome switches 2024-04-30 16:22:55 +02:00
41e2e1359a make area optional and add EasyHome switches 2024-04-30 09:43:45 +02:00
3dcfc3e5ba add mqtt with ha components
configure Pollin switches
2024-04-30 08:08:38 +02:00
14a984195f keep serial logic common
RX pin does not work as RC recevier for huzzah
2024-04-29 14:31:57 +02:00
6a2450d94f dedicated reponse and error handling for each board 2024-04-27 16:50:09 +02:00
638f6b5939 cleanup wifi:
- remove disconnected - not used
- remove tConnected - duplicate of stationConnectedHandler
2024-04-27 16:06:59 +02:00
cb53ad131a remove unused blink 2024-04-27 16:05:35 +02:00
61a7ca0bde separate pro-mini and huzzah logic into dedicated files 2024-04-27 00:00:11 +02:00
100a89a92f add huzzah with support for ota and wifi 2024-04-26 13:45:10 +02:00
5b30e0317d fix warning about const char & upgrade arduino json library 2024-04-26 13:26:07 +02:00
50d48dcfe2 Merge branch 'oil_sensor-switch' into gateway 2023-05-19 10:49:32 +02:00
fdc7712b9d Merge branch 'f/advanced-receiver' into gateway 2023-05-19 10:41:30 +02:00
672691fe00 add support for displaying raw values - for finding new remotes 2023-05-17 16:31:23 +02:00
8e8fdf6611 add fritzing for oil sensor 2023-02-22 23:00:22 +01:00
9862b91bf1 use pro mini as sensor with attiny85 as controller 2023-02-22 23:00:22 +01:00
4cee82f28d update documentation 2023-02-22 22:30:24 +01:00
bfe2280d16 Merge branch 'gateway' 2023-02-20 20:19:56 +01:00
50b0762604 Merge branch 'gw/testing' into gateway
- move all tests into native
2023-01-28 09:10:11 +01:00
65b9ce8dc1 remove embedded test from pipeline 2023-01-28 09:09:40 +01:00
37fc2ab103 move sensor_builder tests into native 2023-01-28 09:09:40 +01:00
624f26c751 update testing 2023-01-28 09:09:40 +01:00
2a591cb28f Merge branch 'gw/serial-reader' into gateway
- use private library for serial reader
- optimize memory usage
- reduce memory needed for json serialization/deserialization
- remove the need for array commands
2023-01-28 09:04:06 +01:00
41ad1b4348 increase reset time
- compensates for old timeout in serial reading
2023-01-22 16:44:01 +01:00
ed755abb14 more json optimization:
- reduce allocated size using correct const/not const char*
- double buffer size for input serial
2023-01-22 14:50:15 +01:00
c61880db57 echo needs to display '\n' 2023-01-21 21:21:15 +01:00
c508092b5c extract error handling to reduce stack mem usage 2023-01-21 19:19:45 +01:00
69554f441a use private serial reader library
array is no longer needed:
- reduce json from 512 to 100
- no need for trailing comma
- no need to use []
2023-01-21 19:18:23 +01:00
a588f56e38 fix: change board to actual pro mini 2023-01-21 16:14:58 +01:00
e75fdac730 don't build & test on production 2023-01-20 14:56:53 +01:00
c8710a1cc9 return error as json and reduce json documents 2022-10-29 13:09:23 +02:00
e3e13c2536 upgrade json library 2022-10-28 16:48:54 +02:00
11f3591d84 add static check 2022-10-28 16:48:51 +02:00
ab04a72996 Merge pull request 'gw/testing' (#4) from gw/testing into gateway
Reviewed-on: #4
2022-10-28 13:43:52 +02:00
5532582531 test max values 2022-10-28 09:00:18 +02:00
5284ce9b41 define masks for tiny components 2022-10-28 09:00:18 +02:00
4ec9b50b1c fix lib path for simavr in pipeline 2022-10-28 09:00:05 +02:00
f9ae76aadf add embedded tests for building sensor 2022-10-27 21:31:49 +02:00
7a10b9e770 fix value construction in tiny 2022-10-27 20:41:09 +02:00
f9a34ff31a extract decoder for easy testing 2022-10-27 17:25:25 +02:00
32d9183b5e add decoded raw_value 2022-10-27 17:10:32 +02:00
1e695faef0 fix sensor building 2022-10-27 15:00:24 +02:00
bdf87cab17 use pointers to fix virtual calls 2022-10-27 15:00:24 +02:00
0ebb9902df fix finding protocol implementation 2022-10-27 15:00:24 +02:00
8319ae3b5d use reference to avoid copying 2022-10-27 10:48:57 +02:00
95dd0f771f separate sensor from generic in protocol 2 2022-10-27 10:44:05 +02:00
f9bcdecb57 cleanup 2022-10-26 10:36:54 +02:00
c053cc9310 separate fromJson logic 2022-10-26 10:36:26 +02:00
1b984d4987 separate toJson logic for each protocol 2022-10-26 10:35:45 +02:00
8f95262fd4 return by value
split protocol handling
2022-10-25 23:23:49 +02:00
640368af42 put back id inside sensor block 2022-10-25 21:33:56 +02:00
f1e67a80d4 fix reference and types 2022-10-25 18:05:37 +02:00
5b1948df26 reverse engineer protocol 1 value 2022-10-25 17:22:08 +02:00
a85f4200c5 Merge pull request 'gateway: execute array but echo each executed command' (#2) from gateway into master
Reviewed-on: #2
2022-10-25 14:02:46 +02:00
389242f493 make a copy of cmd, ArudinoJson alters original one 2022-10-24 20:59:07 +02:00
d232bc4ffa write json directly into Serial 2022-10-24 20:58:46 +02:00
ac8dd2c807 refactor into smaller functions 2022-10-24 20:54:45 +02:00
cb95fbba71 echo every command in array 2022-10-24 20:54:38 +02:00
711ba29f15 Merge branch 'oil_sensor' 2022-10-17 15:13:21 +02:00
52ad568dc1 Merge branch 'gateway' 2022-10-17 15:09:21 +02:00
7f0697227a Merge branch 'temp_sensor' 2022-10-17 15:08:46 +02:00
d803b2402d update measure interval to 1h 2022-10-17 14:14:23 +02:00
d1fd249397 move voltage under diagnostic 2022-10-15 13:00:42 +02:00
0e92f31c4b switch back to NaN as string 2022-10-15 13:00:38 +02:00
ce36b712db Merge pull request 'gateway: adapt it to publish sensors on MQTT' (#1) from gateway into master
Reviewed-on: #1
2022-10-13 20:28:46 +02:00
41e777f586 use builtin NaN for 0 voltage 2022-10-13 20:21:41 +02:00
1a8ddfacae convert values of sensors to float 2022-10-13 20:03:17 +02:00
4b5c6b930f don't send 0 voltage 2022-10-13 20:03:17 +02:00
0cd557f4d5 stop ser2net to avoid conflicts when uploading 2022-10-13 20:01:07 +02:00
77c6c06a6a move id outside sensor block 2022-10-12 10:54:29 +02:00
3b07c1c30c run pipeline for gateway branch 2022-10-12 10:52:22 +02:00
5957c39045 extract Dht in separate file and disable it 2022-10-08 16:08:12 +02:00
fed3fd3866 decrease send frequency 2022-10-07 19:52:34 +02:00
ef00f5f417 turn on/off sonar sensor 2022-10-07 13:45:25 +02:00
7dcbbfa57f optimize sending logic 2022-10-07 13:45:25 +02:00
9ad40ba8e6 add sonar sensor 2022-10-07 13:45:25 +02:00
c58bca75d8 use official rc-switch library 2022-10-07 13:43:42 +02:00
00c185d4a1 update workspace after split 2022-10-07 13:43:36 +02:00
244 changed files with 2522 additions and 25808 deletions

View File

@ -1,25 +1,46 @@
---
kind: pipeline
type: exec
name: upload gateway firmare
name: gateway pipeline
platform:
os: linux
arch: arm
steps:
- name: upload
- name: static check
commands:
- cd gateway
- pio check -e pro-mini
when:
target:
exclude:
- production
- name: native tests
commands:
- cd gateway
- pio test -e native
when:
target:
exclude:
- production
- name: upload firmware
commands:
- cd gateway
- service ser2net stop
- pio run -e pro-mini
- echo -n 'reset' > /dev/ttyUSB0; sleep 1s; avrdude -patmega328p -carduino -P/dev/ttyUSB0 -b115200 -D -Uflash:w:.pio/build/pro-mini/firmware.hex:i -v
- echo 'reset' > /dev/ttyUSB0; sleep 1s; avrdude -patmega328p -carduino -P/dev/ttyUSB0 -b115200 -D -Uflash:w:.pio/build/pro-mini/firmware.hex:i -v
- service ser2net start
when:
target:
- production
trigger:
branch:
- master
- gateway
- gw/*
node:
host: homebox

2
.gitattributes vendored Normal file
View File

@ -0,0 +1,2 @@
*.png filter=lfs diff=lfs merge=lfs -text
*.fzz filter=lfs diff=lfs merge=lfs -text

12
.gitignore vendored
View File

@ -1,9 +1,3 @@
.metadata/
.settings
.project
.cproject
.ino*
Release/
Prototype/
OTA/
.*/
.pio/
.vscode/
credentials.h

3
.gitmodules vendored
View File

@ -1,3 +0,0 @@
[submodule "libraries/RF24"]
path = libraries/RF24
url = https://git.hodos.ro/3rd_party/RF24.git

674
LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 2025 Nicolae Hodos
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) 2025 Nicolae Hodos
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

225
README.md Normal file
View File

@ -0,0 +1,225 @@
# A gateway for 433 MHz devices
It uses [rc_switch](https://github.com/sui77/rc-switch) library for controlling wall sockets and receiving data from sensors. The library supports multiple protocols, the ones used by this gateway are:
- Protocol 1, 2, 4, and 5 for wall switches
- Protocol 2 for sensors
- It can be extended to support more protocols
It works with 2 possible hardwares: Arduino Pro Mini and ESP8266 (currently in use). The code specific to each microcontroller is activated using `#define` directive:
``` C
#if defined(ESP8266)
#include "huzzah.h"
#else
#include "pro-mini.h"
#endif
```
## Serial communication using Arduino Pro Mini
It works with an Arduino Pro Mini 5v 16 Mhz, where the original bootloader has been replaced with Optiboot using this tutorial: https://andreasrohner.at/posts/Electronics/How-to-make-the-Watchdog-Timer-work-on-an-Arduino-Pro-Mini-by-replacing-the-bootloader/
It is used as a serial gateway communicating in JSON format, when connected to a Raspberry Pi running Home Assistant.
### Mode of operation:
- it receives commands in JSON format over serial and translates them into RC commands to be sent to wall switches: ON/OFF
- it receives sates from sensors, or RC commands from RC remotes, and translates them into JSON, which is written on `Serial` to be consumed by HA
## MQTT communication using ESP8266
It works with any ESP8266 board, an [Adafruit Huzzah](https://learn.adafruit.com/adafruit-huzzah-esp8266-breakout) in this case.
It is used as a gateway communicating in JSON format with Home Assistant, by publishing and subscribing to topics on MQTT. Devices on Home Assistant side are configured automatically using [MQTT discovery](https://www.home-assistant.io/integrations/mqtt/#configuration-via-mqtt-discovery).
### Mode of operation:
- it receives commands over MQTT and translates them into RC commands to be sent to wall switches: ON/OFF
- it receives sates from sensors, or RC commands from RC remotes, translates them into JSON and updates devices in HA by publishing messages on MQTT
## Sensors
Sensors transmit state using `Protocol 2`, a 32 bit unsigned number.
#### Protocol structure
```
STATE
|
1010|1|101010101|1010101010101|10101
----|-----------|-------------|-----
TYPE| VALUE | VCC | ID
```
where:
- **ID**: uniquely identifies a sensor
- **TYPE**: the type of the sensor, see bellow
- **VALUE**: used for _GENERIC_, _HUMIDITY_ and _TEMPERATURE_ sensors
- **STATE**: used for _CONTACT_ sensor only; since it doesn't conflict with other sensor types, it uses one bit from **VALUE**
- **VCC**: battery voltage, used to detect when batteries need to be replaced
#### Sensors types
```C++
enum SensorType : uint8_t {
GENERIC = 4,
HUMIDITY = 5,
TEMPERATURE = 6,
CONTACT = 7
};
```
#### Sensors IDs
```C++
enum SensorId : uint8_t {
WINDOW1 = 1,
WINDOW2 = 2,
WATER_SENSOR = 3,
TEMP_SENSOR = 4,
LIGHT_SENSOR = 5,
MOVEMENT_SENSOR = 6,
OIL_SENSOR = 7
};
```
### Devices
#### [Servers room temperature](./devices/temp_sensor/)
Type: **TEMPERATURE**
##### Value and voltage
```json
{
"sensor": {
"id": 4,
"diagnostic": {
"voltage": 2.239
},
"temperature": 16.2
}
}
```
##### Value only
```json
{
"sensor": {
"id": 4,
"temperature": 16.2
}
}
```
#### [Oil tank sensor](./devices/oil_sensor/)
Type: **GENERIC**
##### Value and voltage
```json
{
"sensor": {
"id": 7,
"diagnostic": {
"voltage": 4.282
},
"value": 13
}
}
```
#### [Presence sensor](./devices/presence_sensor/)
Type: **CONTACT**
##### Value and voltage
```json
{
"sensor": {
"id": 8,
"diagnostic": {
"voltage": 3.28
},
"value": 1
}
}
```
## Switches
Gateway receives remote commands over RC Switch and translates them into JSON.
#### Protocol 1
##### ON
```json
{
"rcSwitch": {
"protocol": 1,
"state": true,
"group": "1",
"channel": 1,
"raw_value": 5571921
}
}
```
##### OFF
```json
{
"rcSwitch": {
"protocol": 1,
"state": false,
"group": "1",
"channel": 1,
"raw_value": 5571921
}
}
```
#### Protocol 2
```json
{
"rcSwitch": {
"protocol": 2,
"value": 2650807673
}
}
```
#### Other protocols
```json
{
"rcSwitch": {
"protocol": 4,
"value": 1234567890
}
}
```
### DHT
Reads local DHT11 sensor and outputs it into JSON.
```
{
"dht11": {
"temperature": 31.9,
"humidity": 45
}
}
```
---
## Commands from Home Assistant
It receives commands in JSON format, over serial or MQTT, and executes them.
#### Protocol 1
##### ON
```json
{
"rcSwitch": {
"protocol": 1,
"group": "00001",
"channel": 1,
"state": true
}
}
```
##### OFF
```json
{
"rcSwitch": {
"protocol": 1,
"group": "00001",
"channel": 1,
"state": false
}
}
```
#### Protocol 2
```json
{
"rcSwitch": {
"protocol": 2,
"value": "10010110000000000001110101111001"
}
}
```
#### Other protocols
```json
{
"rcSwitch": {
"protocol": 4,
"value": "010001101001100101110100"
}
}
```

10
devices/README.md Normal file
View File

@ -0,0 +1,10 @@
# Gateway & sensors
## Branches
Each sensor has a dedicated branch. E.g.:
* temp_sensor
* oil_sensor
The gateway uses `master` as the main branch. Other sensors' branches get merged once they are ready for production.
## Release flow

View File

@ -0,0 +1,20 @@
# Oil sensor
Using an ultra sonic sensor, it detects the amount of oil used for heating.
For optimization purposes, it uses 2 microcontrollers:
#### **Arduino Pro Mini**
It offers a precise quartz clock, required by the ultra sonic sensor to accurately determine the level of oil in the tank. But because it has a high consumption, it is not suited for battery powered devices.
#### **ATTiny85**
It has an inaccurate quartz clock that cannot be used for the sonar sensor, but it is more than enough to be used as a wake-up device for Arduino Pro Mini. Due to the very low power consumption, it is ideal for battery powered devices.
## Mode of operation
ATTiny85 is connected directly to the battery and acts as a power switch:
1. on regular intervals, ~6 hours, it powers on the Arduino Pro Mini
1. Arduino Pro Mini will:
- read the oil tank level
- send the information to the RC Gateway
- signal the ATTiny85 that it has finished
1. turns off the Arduino Pro Mini
![Schematics](docs/oil_sensor_bb.png)

BIN
devices/oil_sensor/docs/oil_sensor.fzz (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/oil_sensor/docs/oil_sensor_bb.png (Stored with Git LFS) Normal file

Binary file not shown.

View File

@ -0,0 +1,16 @@
#pragma once
#include "GenericSensor.h"
#include <NewPing.h>
class SonarSensor : public GenericSensor {
private:
NewPing sonar{ TRIGGER_PIN, ECHO_PIN, MAX_DISTANCE };
public:
SonarSensor(short id) : GenericSensor(id) {}
unsigned int scan() {
return sonar.convert_cm(sonar.ping_median());
}
};

View File

@ -0,0 +1,34 @@
; PlatformIO Project Configuration File
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html
[env:attiny85]
platform = atmelavr
board = attiny85
framework = arduino
build_src_filter = +<switch.cpp>
lib_extra_dirs =
../../lib
upload_protocol = stk500v1
upload_flags =
-P$UPLOAD_PORT
-b$UPLOAD_SPEED
upload_port = /dev/ttyACM0
upload_speed = 19200
[env:pro_mini]
platform = atmelavr
board = pro16MHzatmega168
framework = arduino
build_src_filter = +<oil_sensor.cpp>
lib_deps =
teckel12/NewPing@^1.9.4
sui77/rc-switch @ ^2.6.4
lib_extra_dirs =
../../lib

View File

@ -0,0 +1,37 @@
#include <Arduino.h>
#define SENDER_GND 10
#define SENDER_DATA 11
#define SENDER_VCC 12
#define TRIGGER_PIN 2
#define ECHO_PIN 3
#define NOTIFY_PIN 9
#define MAX_DISTANCE 200 // 2 meters
#include "SonarSensor.h"
SonarSensor oilSensor(OIL_SENSOR);
void setup() {
Serial.begin(9600);
Serial.println("starting...");
pinMode(SENDER_GND, OUTPUT);
digitalWrite(SENDER_GND, LOW);
pinMode(SENDER_VCC, OUTPUT);
digitalWrite(SENDER_VCC, HIGH);
TinySwitch::setup(SENDER_DATA);
delay(300);
unsigned int distance = oilSensor.scan();
Serial.println(distance);
if (distance) oilSensor.sendValueAndVoltage(distance);
delay(200);
pinMode(NOTIFY_PIN, OUTPUT);
digitalWrite(NOTIFY_PIN, LOW);
Serial.println("finished");
}
void loop() {
}

View File

@ -0,0 +1,41 @@
#include <Arduino.h>
#include <TinyPower.h>
#define CONTROLLER_PIN PIN_B4
#define NOTIFICATION_PIN PIN_B0
#define HOUR_INTERVAL 450 // 450*8s = ~1 hour
#define WAKE_INTERVAL (HOUR_INTERVAL*12) // ~12 hours
volatile int counter = 0;
volatile bool wakeUp = true;
void setup() {
pinMode(PIN_B3, INPUT);
pinMode(CONTROLLER_PIN, OUTPUT);
digitalWrite(CONTROLLER_PIN, LOW);
pinMode(NOTIFICATION_PIN, INPUT_PULLUP);
TinyPower::setup();
TinyPower::enableWdt(WDTO_8S);
}
void loop() {
if (wakeUp) {
wakeUp = false;
digitalWrite(CONTROLLER_PIN, HIGH);
}
TinyPower::sleep(NOTIFICATION_PIN);
}
ISR(WDT_vect) {
counter++;
if ((counter % WAKE_INTERVAL == 0)) {
wakeUp = true;
}
}
ISR(PCINT0_vect) {
if (!digitalRead(NOTIFICATION_PIN))
digitalWrite(CONTROLLER_PIN, LOW);
}

View File

@ -0,0 +1,5 @@
# Presence ticker
It sends state on regular intervals, so that presence of the bearer can be tracked.
![Schematics](docs/presence_sensor_bb.png)

BIN
devices/presence_sensor/docs/presence_sensor.fzz (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/presence_sensor/docs/presence_sensor_bb.png (Stored with Git LFS) Normal file

Binary file not shown.

View File

@ -8,15 +8,17 @@
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html
[env:pro-mini]
[env:attiny85]
platform = atmelavr
board = miniatmega328
board = attiny85
framework = arduino
lib_extra_dirs =
../libraries
lib_deps =
sui77/rc-switch@^2.6.3
bblanchon/ArduinoJson@6.16.1
adafruit/Adafruit Unified Sensor@^1.1.4
adafruit/DHT sensor library@1.3.10
upload_port = /dev/ttyUSB0
lib_deps =
sui77/rc-switch @ ^2.6.4
lib_extra_dirs =
../../lib
upload_protocol = stk500v1
upload_flags =
-P$UPLOAD_PORT
-b$UPLOAD_SPEED
upload_port = /dev/ttyACM0
upload_speed = 19200

View File

@ -0,0 +1,37 @@
#include <Arduino.h>
#include <TinyPower.h>
#include "ContactSensor.h"
#define MINUTES(value) (uint16_t)(value*60/8) // minutes*60(seconds)/8s(WDT)
#define HOURS(value) (uint16_t)(MINUTES(value)*60)
#define SEND_INTERVAL MINUTES(2)
#define SEND_VCC_INTERVAL HOURS(6)
// Pins
#define SENDER_PIN PIN_B2
volatile uint16_t counter = 0;
ContactSensor sensor(PRESENCE_SENSOR);
void setup() {
TinySwitch::setup(SENDER_PIN);
TinyPower::setup();
TinyPower::enableWdt(WDTO_8S);
}
void loop() {
if (counter == 0) {
sensor.sendStateAndVoltage(false);
} else if (counter % SEND_INTERVAL == 0) {
sensor.sendState(false);
}
TinyPower::sleep();
}
ISR(WDT_vect) {
if (++counter % SEND_VCC_INTERVAL == 0) {
counter = 0;
}
}

5
devices/temp_sensor/.gitignore vendored Normal file
View File

@ -0,0 +1,5 @@
.pio
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch

View File

@ -1,13 +1,13 @@
# Temperature sensor
It uses a [TMP36](https://cloud.hodos.ro/wiki/ha/datasheets/TMP35_36_37.pdf) to read temperature and it is optimised for power consumption.
It uses watch dog that wakes every 8s and increments a counter. Once the counter reaches a certain value (e.g. equivalent to 5 mins), it will read and send temperature to the gateway.
Every hour the voltage is also read and sent.
It uses watch dog that wakes every 8s and increments a counter. Once the counter reaches a certain value (e.g. equivalent to 1 hour), it will read and send temperature to the gateway.
Every 12 hours the voltage is also read and sent.
According to the calculator here, https://www.geekstips.com/battery-life-calculator-sleep-mode/, a cell coin battery with a capacity of `240mAh` should last for
`~ 3 months (108 days)`, given that:
According to the [battery life calculator](https://www.allaboutcircuits.com/tools/battery-lifetime-calculator/), a cell coin battery with a capacity of `200mAh` should last for
`~ 3 years`, given that:
- Current consumption of device during sleep is `4.5uA`
- Device wakes up every `5 mins (12 times/hour)`
- Device wakes up every `hour`
- Current consumption of device during wake is `10mA`
- Duration of wake time is `1000 ms`

BIN
devices/temp_sensor/docs/temp_sensor.fzz (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/temp_sensor/docs/temp_sensor_bb.png (Stored with Git LFS) Normal file

Binary file not shown.

View File

@ -0,0 +1,39 @@
This directory is intended for project header files.
A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.
```src/main.c
#include "header.h"
int main (void)
{
...
}
```
Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.
In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.
Read more about using header files in official GCC documentation:
* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

View File

@ -0,0 +1,46 @@
This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.
The source code of each library should be placed in a an own separate directory
("lib/your_library_name/[here are source files]").
For example, see a structure of the following two libraries `Foo` and `Bar`:
|--lib
| |
| |--Bar
| | |--docs
| | |--examples
| | |--src
| | |- Bar.c
| | |- Bar.h
| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
| |
| |--Foo
| | |- Foo.c
| | |- Foo.h
| |
| |- README --> THIS FILE
|
|- platformio.ini
|--src
|- main.c
and a contents of `src/main.c`:
```
#include <Foo.h>
#include <Bar.h>
int main (void)
{
...
}
```
PlatformIO Library Dependency Finder will find automatically dependent
libraries scanning project source files.
More information about PlatformIO Library Dependency Finder
- https://docs.platformio.org/page/librarymanager/ldf.html

View File

@ -15,9 +15,9 @@ framework = arduino
lib_deps =
adafruit/Adafruit Unified Sensor @ ^1.1.4
adafruit/DHT sensor library@^1.4.3
sui77/rc-switch @ ^2.6.4
lib_extra_dirs =
../libraries
~/Arduino/libraries
../../lib
build_flags = -D DHT_SENSOR=0
upload_protocol = stk500v1
upload_flags =

View File

@ -3,8 +3,8 @@
#include "Tmp36Sensor.h"
#include "Dht22Sensor.h"
#define SEND_INTERVAL 37 // 37*8s = ~5min
#define SEND_VCC_INTERVAL (SEND_INTERVAL*6) // every half hour
#define SEND_INTERVAL 450 // 450*8s = ~60min
#define SEND_VCC_INTERVAL (SEND_INTERVAL*12) // every 12 hours
// Pins
#define SENDER PIN_B2

View File

@ -0,0 +1,11 @@
This directory is intended for PlatformIO Unit Testing and project tests.
Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.
More information about PlatformIO Unit Testing:
- https://docs.platformio.org/page/plus/unit-testing.html

BIN
devices/window1/wiki/breadboard.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/window1/wiki/schema.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/window1/wiki/window1.fzz (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/window2/wiki/breadboard.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/window2/wiki/schema.png (Stored with Git LFS) Normal file

Binary file not shown.

BIN
devices/window2/wiki/window2.fzz (Stored with Git LFS) Normal file

Binary file not shown.

View File

@ -1,57 +0,0 @@
# A gateway for 433 MHz devices
It uses [rc_switch](https://github.com/sui77/rc-switch) library for controlling wall sockets.
It also supports receiving commands from the same protocol.
It acts as a serial gateway and it is connected to a Raspberry Pi running Home assistant.
It uses an Arduino Pro Mini 5v 16 Mhz.
The original bootloader has been replaced with Optiboot using this tutorial: https://andreasrohner.at/posts/Electronics/How-to-make-the-Watchdog-Timer-work-on-an-Arduino-Pro-Mini-by-replacing-the-bootloader/
## Read sensors
### DHT
```
{
"dht11": {
"temperature": 31.9,
"humidity": 45
}
}
```
### RC Switch
#### on
```
[
{
"rcSwitch": {
"protocol": 1,
"group": "00001",
"channel": 1,
"state": true
}
}
]
```
#### off
```
[
{
"rcSwitch": {
"protocol": 1,
"group": "00001",
"channel": 1,
"state": false
}
}
]
```
```
[
{
"rcSwitch": {
"protocol": 2,
"value": "10011110000000000001110101111001"
}
}
]
```

View File

@ -1,166 +0,0 @@
#include <Arduino.h>
#include <RCSwitch.h>
#include <ArduinoJson.h>
#include <Adafruit_Sensor.h>
#include <DHT.h>
#include "Tiny.h"
#define RESET_PIN 10
#define SEND_PIN 11
#define RECEIVE_PIN 2
#define DHT11_PIN 12
#define READ_INTERVAL(c) (c*60*1000UL) // read interval in minutes
unsigned long currentTime = 0;
RCSwitch mySwitch = RCSwitch();
DHT dht = DHT(DHT11_PIN, DHT11);
void readRcSwitch(JsonDocument& jsonDoc);
void readCommand();
void readDht(JsonDocument& jsonDoc);
void setup() {
digitalWrite(RESET_PIN, HIGH);
pinMode(LED_BUILTIN, OUTPUT);
pinMode(RESET_PIN, OUTPUT);
mySwitch.enableReceive(digitalPinToInterrupt(RECEIVE_PIN));
mySwitch.enableTransmit(SEND_PIN);
mySwitch.setRepeatTransmit(10);
dht.begin();
Serial.begin(9600);
delay(1000);
}
void loop() {
currentTime = millis();
StaticJsonDocument<200> jsonDoc;
readCommand();
readRcSwitch(jsonDoc);
readDht(jsonDoc);
if (!jsonDoc.isNull()) {
serializeJson(jsonDoc, Serial);
Serial.println();
}
}
void readRcSwitch(JsonDocument& jsonDoc) {
if (mySwitch.available()) {
unsigned long value = mySwitch.getReceivedValue();
mySwitch.resetAvailable();
if (mySwitch.getReceivedProtocol() == 2) {
if (value == 637541753L || value == 771759481L) {
JsonObject motion = jsonDoc.createNestedObject("motion");
motion["kitchen"] = value == 637541753L ? "on" : "off";
return;
}
if (value == 1879048230L || value == 1879048198L) {
JsonObject motion = jsonDoc.createNestedObject("motion");
motion["basement"] = value == 1879048230L ? "on" : "off";
return;
}
if (GET_TYPE(value) == SensorType::GENERIC) {
JsonObject sensor = jsonDoc.createNestedObject("sensor");
sensor["id"] = ID(value);
sensor["value"] = GET_VALUE(value);
sensor["voltage"] = GET_VCC(value);
return;
}
if (GET_TYPE(value) == SensorType::TEMPERATURE) {
JsonObject sensor = jsonDoc.createNestedObject("sensor");
sensor["id"] = ID(value);
sensor["temperature"] = GET_TEMP(value);
sensor["voltage"] = GET_VCC(value);
return;
}
if (GET_TYPE(value) == SensorType::HUMIDITY) {
JsonObject sensor = jsonDoc.createNestedObject("sensor");
sensor["id"] = ID(value);
sensor["humidity"] = GET_HUMIDITY(value);
sensor["voltage"] = GET_VCC(value);
return;
}
if (GET_TYPE(value) == SensorType::CONTACT) {
JsonObject sensor = jsonDoc.createNestedObject("contact");
sensor["id"] = ID(value);
sensor["state"] = GET_STATE(value) ? "on" : "off";
sensor["voltage"] = GET_VCC(value);
return;
}
}
JsonObject rcSwitch = jsonDoc.createNestedObject("rcSwitch");
rcSwitch["protocol"] = mySwitch.getReceivedProtocol();
rcSwitch["value"] = value;
}
}
void blink() {
digitalWrite(LED_BUILTIN, HIGH);
delay(200);
digitalWrite(LED_BUILTIN, LOW);
}
void runJsonCommand(String cmd) {
StaticJsonDocument<256> jsonArray;
DeserializationError err = deserializeJson(jsonArray, cmd);
if (err == DeserializationError::Ok) {
JsonArray array = jsonArray.as<JsonArray>();
for(JsonVariant jsonDoc : array) {
if (jsonDoc.containsKey("rcSwitch")) {
JsonObject rcSwitch = jsonDoc["rcSwitch"];
unsigned int protocol = rcSwitch["protocol"];
if (protocol == 1) {
mySwitch.setProtocol(protocol);
char* group = rcSwitch["group"];
int channel = rcSwitch["channel"];
if (rcSwitch["state"]) {
mySwitch.switchOn(group, channel);
} else {
mySwitch.switchOff(group, channel);
}
} else {
mySwitch.setProtocol(protocol);
mySwitch.send(rcSwitch["value"]);
// Serial.println((const char*)rcSwitch["value"]);
}
blink();
} else {
Serial.println(err.c_str());
}
}
}
}
void readCommand() {
if (Serial.available() > 0) {
String cmd = Serial.readStringUntil('\n');
if (cmd == "reset") {
Serial.println("resetting...");
delay(200);
digitalWrite(RESET_PIN, LOW);
Serial.println("resetting failed");
}
if (cmd.endsWith(",")) {
cmd = cmd.substring(0, cmd.lastIndexOf(','));
}
cmd = "[" + cmd + "]";
Serial.println(cmd);
runJsonCommand(cmd);
}
}
void readDht(JsonDocument& jsonDoc) {
static unsigned long lastReadTime = 0;
if (currentTime > lastReadTime) {
lastReadTime = currentTime + READ_INTERVAL(5);
JsonObject dht11 = jsonDoc.createNestedObject("dht11");
dht11["temperature"] = dht.readTemperature();
dht11["humidity"] = dht.readHumidity();
}
}

40
include/Dht.h Normal file
View File

@ -0,0 +1,40 @@
#if DHT_SENSOR
#include <ArduinoJson.h>
#include <Adafruit_Sensor.h>
#include <DHT.h>
#define DHT11_PIN 12
#define READ_INTERVAL(c) (c*60*1000UL) // read interval in minutes
DHT dht = DHT(DHT11_PIN, DHT11);
uint32_t currentTime = 0;
namespace Dht {
void setup() {
dht.begin();
}
void read() {
currentTime = millis();
static uint32_t lastReadTime = 0;
if (currentTime > lastReadTime) {
lastReadTime = currentTime + READ_INTERVAL(5);
StaticJsonDocument<200> jsonDoc;
JsonObject dht11 = jsonDoc.createNestedObject("dht11");
dht11["temperature"] = dht.readTemperature();
dht11["humidity"] = dht.readHumidity();
serializeJson(jsonDoc, Serial);
Serial.println();
}
}
}
#else
namespace Dht {
void setup() {
}
void read() {
}
}
#endif

35
include/Protocol.h Normal file
View File

@ -0,0 +1,35 @@
#pragma once
#include <ArduinoJson.h>
#include <RCSwitch.h>
enum ProtocolNo : uint8_t {
NO_PROTOCOL = 0,
PROTOCOL_1 = 1,
PROTOCOL_2 = 2,
PROTOCOL_13 = 13
};
class Protocol {
protected:
ProtocolNo no;
public:
explicit Protocol(ProtocolNo protocol) : no(protocol) {}
Protocol& setProtocol(uint8_t p) {
no = static_cast<ProtocolNo>(p);
return *this;
}
virtual void fromJson(JsonObjectConst& rcSwitch, RCSwitch& rcDevice) {
ProtocolNo protocol = rcSwitch["protocol"];
rcDevice.setProtocol(protocol);
rcDevice.send(rcSwitch["value"]);
}
virtual void toJson(uint32_t value, JsonDocument& jsonDoc) {
JsonObject rcSwitch = jsonDoc.createNestedObject("rcSwitch");
rcSwitch["protocol"] = no;
rcSwitch["value"] = value;
}
} fallbackProtocol{ NO_PROTOCOL };

36
include/Protocol_1.h Normal file
View File

@ -0,0 +1,36 @@
#pragma once
#include "Protocol.h"
#include "RcDecoder.h"
class Protocol_1 : public Protocol {
public:
Protocol_1() : Protocol(PROTOCOL_1) {}
void fromJson(JsonObjectConst& rcSwitch, RCSwitch& rcDevice) override {
ProtocolNo protocol = rcSwitch["protocol"];
rcDevice.setProtocol(protocol);
const char* group = rcSwitch["group"];
int channel = rcSwitch["channel"];
rcSwitch["state"] ? rcDevice.switchOn(group, channel) : rcDevice.switchOff(group, channel);
}
void toJson(uint32_t value, JsonDocument& jsonDoc) override {
JsonObject rcSwitch = jsonDoc.createNestedObject("rcSwitch");
rcSwitch["protocol"] = no;
RcDecoder decoder;
decoder.decode(value);
rcSwitch["state"] = decoder.state;
rcSwitch["group"] = decoder.group;
rcSwitch["channel"] = decoder.device;
rcSwitch["raw_value"] = value;
}
#if defined(ESP8266)
static std::string buildId(const char* group, const uint8_t channel) {
char uId[30];
sprintf(uId, "%s_%u", group, channel);
return std::string{ uId };
}
#endif
} protocol1;

35
include/Protocol_2.h Normal file
View File

@ -0,0 +1,35 @@
#pragma once
#include "Protocol.h"
#include "TinyComponent.h"
class Protocol_2 : public Protocol {
public:
Protocol_2() : Protocol(PROTOCOL_2) {}
void toJson(uint32_t value, JsonDocument& jsonDoc) override {
switch (value) {
case 637541753L:
case 771759481L: {
JsonObject motion = jsonDoc.createNestedObject("motion");
motion["kitchen"] = value == 637541753L ? "on" : "off";
break;
}
case 1879048230L:
case 1879048198L: {
JsonObject motion = jsonDoc.createNestedObject("motion");
motion["basement"] = value == 1879048230L ? "on" : "off";
break;
}
default:
StaticJsonDocument<200> jsonSensor;
if (buildSensorJson(value, jsonSensor)) {
jsonDoc.set(jsonSensor);
} else {
Protocol::toJson(value, jsonDoc);
}
break;
}
}
} protocol2;

View File

@ -0,0 +1,62 @@
#pragma once
#if ENABLE_DOORBELL
#include "Protocol.h"
#define BIT_LENGTH 40
#define BIT_LENGTH_3 BIT_LENGTH*3
#define TX_DELAY 620
class Protocol_Doorbell : public Protocol {
public:
Protocol_Doorbell() : Protocol(PROTOCOL_13) {}
void ring(const char* value) {
preamble();
for (int i = 0; i < 7; i++) {
delayMicroseconds(TX_DELAY);
code(value);
}
}
private:
void transmitBit(uint8_t value) {
digitalWrite(SEND_PIN, value);
delayMicroseconds(BIT_LENGTH);
digitalWrite(SEND_PIN, LOW);
}
void transmitHigh() {
digitalWrite(SEND_PIN, HIGH);
delayMicroseconds(BIT_LENGTH_3);
digitalWrite(SEND_PIN, LOW);
delayMicroseconds(BIT_LENGTH);
}
void transmitLow() {
digitalWrite(SEND_PIN, HIGH);
delayMicroseconds(BIT_LENGTH);
digitalWrite(SEND_PIN, LOW);
delayMicroseconds(BIT_LENGTH_3);
}
void preamble() {
noInterrupts();
for (int i = 0; i < 370; i++) {
transmitBit(HIGH);
transmitBit(LOW);
}
interrupts();
}
void code(const char* value) {
noInterrupts();
for (const char* p = value; *p; p++) {
*p == '1' ? transmitHigh() : transmitLow();
}
interrupts();
}
} doorbell;
#endif

39
include/README Normal file
View File

@ -0,0 +1,39 @@
This directory is intended for project header files.
A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in `src` folder
by including it, with the C preprocessing directive `#include'.
```src/main.c
#include "header.h"
int main (void)
{
...
}
```
Including a header file produces the same results as copying the header file
into each source file that needs it. Such copying would be time-consuming
and error-prone. With a header file, the related declarations appear
in only one place. If they need to be changed, they can be changed in one
place, and programs that include the header file will automatically use the
new version when next recompiled. The header file eliminates the labor of
finding and changing all the copies as well as the risk that a failure to
find one copy will result in inconsistencies within a program.
In C, the usual convention is to give header files names that end with `.h'.
It is most portable to use only letters, digits, dashes, and underscores in
header file names, and at most one dot.
Read more about using header files in official GCC documentation:
* Include Syntax
* Include Operation
* Once-Only Headers
* Computed Includes
https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

38
include/RcDecoder.h Normal file
View File

@ -0,0 +1,38 @@
#define RC_STATE(value) value & 0x1
#define RC_DEVICE(value) (value >> 1) & 0x1F
#define RC_GROUP(value) (value >> 6) & 0x1F
struct RcDecoder {
bool state;
char group[6];
uint8_t device;
void decode(uint32_t value) {
value = value >> 2;
uint32_t res = 0;
for (int i = 0; i < 12; i++) {
res |= ((value & 1) ^ 1) << i;
value = value >> 2;
}
state = RC_STATE(res);
sprintf(group, "%05u", RC_GROUP(res));
switch (RC_DEVICE(res)) {
case 0b10000:
device = 1;
break;
case 0b01000:
device = 2;
break;
case 0b00100:
device = 3;
break;
case 0b00010:
device = 4;
break;
case 0b00001:
device = 5;
break;
}
}
};

34
include/TinyComponent.h Normal file
View File

@ -0,0 +1,34 @@
#include <ArduinoJson.h>
#include "Tiny.h"
bool buildSensorJson(uint32_t value, JsonDocument& jsonDoc) {
JsonObject sensor = jsonDoc.createNestedObject("sensor");
sensor["id"] = ID(value);
float voltage = (float)GET_VCC(value) / 1000;
JsonObject diagnostic = sensor.createNestedObject("diagnostic");
if (voltage != 0) {
diagnostic["voltage"] = voltage;
} else {
diagnostic["voltage"] = "";
}
switch (GET_TYPE(value)) {
case SensorType::GENERIC:
sensor["value"] = GET_VALUE(value);
break;
case SensorType::TEMPERATURE:
sensor["temperature"] = (float)GET_TEMP(value) / 10;
break;
case SensorType::HUMIDITY:
sensor["humidity"] = (float)GET_HUMIDITY(value) / 10;
break;
case SensorType::CONTACT:
sensor["state"] = GET_STATE(value) ? "ON" : "OFF";
break;
default:
return false;
}
return true;
}

82
include/devices.h Normal file
View File

@ -0,0 +1,82 @@
#pragma once
#include "rc_devices.h"
using namespace Ha;
auto roomSensor = Builder<TemperatureSensor>(TEMP_SENSOR)
.asDevice(&DeviceConfig::create(TEMP_SENSOR)
.withName("Servers room")
.withManufacturer("Atmel")
.withModel("AtTiny85")
.withArea("Basement")
.withParent(gatewayDevice))
.withValueTemplate("{{ value_json.sensor.temperature }}")
.addPreconfigured(batterySensors<TemperatureSensor>(TEMP_SENSOR, BATTERY_PERCENTAGE_TEMPLATE(2.5, 2)))
.build();
auto tankSensor = Builder<Sensor>(new Sensor{ "Level", OIL_SENSOR })
.asDevice(&DeviceConfig::create(OIL_SENSOR)
.withName("Oil tank")
.withManufacturer("Arduino")
.withModel("Pro Mini")
.withArea("Basement")
.withParent(gatewayDevice))
.withUnitMeasure("%")
.withSensorStateClass(MEASUREMENT)
.withIcon("mdi:hydraulic-oil-level")
.withValueTemplate("{{ 100 - ((value_json.sensor.value-12)|float*100/120)|round(2) }}")
.addSecondary(
Builder<Sensor>(new Sensor{ "Depth", OIL_SENSOR })
.withDeviceClass("distance")
.withUnitMeasure("cm")
.withSensorStateClass(MEASUREMENT)
.withValueTemplate("{{ value_json.sensor.value }}")
.build()
)
.addPreconfigured(batterySensors<Sensor>(OIL_SENSOR, BATTERY_PERCENTAGE_TEMPLATE(4, 2.4)))
.build();
auto presenceTracker = Builder<BinarySensor>(PRESENCE_SENSOR)
.asDevice(&DeviceConfig::create(PRESENCE_SENSOR)
.withName("Kid presence")
.withManufacturer("Atmel")
.withModel("AtTiny85")
.withParent(gatewayDevice))
.withValueTemplate("{{ value_json.sensor.state }}")
.addPreconfigured(batterySensors<BinarySensor>(PRESENCE_SENSOR, BATTERY_PERCENTAGE_TEMPLATE(2.7, 0.6)))
.withOffDelaySeconds(5*60)
.withDeviceClass("presence")
.build();
Command* commands[] = {
HaESP::restartButton()
.asDevice(gatewayDevice)
.addPreconfigured(HaESP::heapStats)
.addPreconfigured(HaESP::restartInfo)
.addPreconfigured(HaESP::wifiInfo)
.build(),
#if ENABLE_DOORBELL
Builder<Button>(new Button{"Front door", "doorbell_front",
[](const char* msg) {
if (strcmp("PRESS", msg) == 0) doorbell.ring("00000000110100101000100");
}
})
.asDevice(
&DeviceConfig::create("doorbell")
.withName("Doorbell")
.withManufacturer("Thomson")
.withModel("Kinetic Halo")
.withParent(gatewayDevice)
)
.build(),
#endif
new EasyHomeSwitch{'A', array<uint32_t, 4>{ 4483136, 4626800, 4661552, 4819632 }, array<uint32_t, 4>{ 4326544, 4537104, 4767520, 4972704 }, "KabelBox", "Basement"},
new EasyHomeSwitch{'B', array<uint32_t, 4>{ 4483140, 4626804, 4661556, 4819636 }, array<uint32_t, 4>{ 4326548, 4537108, 4767524, 4972708 }, "Router ext", "Dining room"},
new PollinSwitch{"00001", 1},
new PollinSwitch{"00001", 2, "Fire Tv", "Living room"},
new PollinSwitch{"00001", 3, "Diningroom player", "Dining room"},
new PollinSwitch{"00001", 4},
new PollinSwitch{"00011", 4, "homebox"},
new PollinSwitch{"11111", 4, "Train", "Playroom"}
};

122
include/huzzah.h Normal file
View File

@ -0,0 +1,122 @@
#include <TaskScheduler.h>
#define MQTT_HOST IPAddress(192, 168, 5, 11)
#define MQTT_PORT 1883
using namespace std;
Scheduler ts;
#include "devices.h"
#include "mqtt.h"
#include "ota.h"
#include "wifi.h"
#include "webserver.h"
#define RAW_TOPIC MAIN_DEVICE_ID "/raw"
namespace Board {
Task tReadCommand(TASK_IMMEDIATE, TASK_FOREVER, [](){
if (serialReader.readLine(Serial) > 0) {
char* cmd = serialReader.getBuffer();
if (strcmp("reset", cmd) == 0) {
Serial.println("resetting...");
ESP.restart();
Serial.println("resetting failed");
}
runJsonCommand(cmd);
}
}, &ts);
void turnLed(uint8_t led, bool on = true) {
on ? digitalWrite(led, LOW) : digitalWrite(led, HIGH);
}
void setup() {
// Serial.begin(9600, SERIAL_8N1, SERIAL_TX_ONLY);
pinMode(RED_LED, OUTPUT);
pinMode(BLUE_LED, OUTPUT);
turnLed(RED_LED, false);
turnLed(BLUE_LED);
WebServer::setup();
Mqtt::setup(&ts,
[] {turnLed(BLUE_LED, false);},
[] {turnLed(BLUE_LED);}
);
Wifi::setup(ts,
[] {
Ota::tLoop.enable();
Mqtt::tReConnect.enable();
WebServer::start();
},
[] {
Ota::tLoop.disable();
Mqtt::tReConnect.disable();
WebServer::stop();
}
);
Ota::setup(
[] {
Mqtt::publishCleanupConfig();
delay(2000);
Mqtt::disconnect();
WebServer::stop();
});
tReadCommand.enable();
}
void loop() {
ts.execute();
}
void parseSwitches(JsonDocument& jsonDoc) {
JsonObjectConst rcSwitch = jsonDoc["rcSwitch"];
switch (static_cast<uint16_t>(rcSwitch["protocol"])) {
case 1: {
string id = Protocol_1::buildId(static_cast<const char*>(rcSwitch["group"]), static_cast<int>(rcSwitch["channel"]));
Ha::Switch* el = p1Switches[id];
if (el) el->updateState(static_cast<bool>(rcSwitch["state"]));
break;
}
case 2:
break;
default: {
uint32_t value = rcSwitch["value"];
auto range = onSwitches.equal_range(value);
for_each(range.first, range.second, [](mapswitches::value_type& x){
x.second->updateState(true);
});
range = offSwitches.equal_range(value);
for_each(range.first, range.second, [](mapswitches::value_type& x){
x.second->updateState(false);
});
}
}
}
void parseSensors(JsonDocument& jsonDoc, char* message) {
JsonObjectConst json = jsonDoc["sensor"];
string id = to_string((uint16_t)json["id"]);
auto sensor = GenericSensor::mapSensors[id];
if (sensor) sensor->updateState(message);
}
void publishResponse(JsonDocument& jsonDoc) {
char message[255];
serializeJson(jsonDoc, message);
Mqtt::publish(RAW_TOPIC, message);
if (jsonDoc.containsKey("rcSwitch")) parseSwitches(jsonDoc);
if (jsonDoc.containsKey("sensor")) parseSensors(jsonDoc, message);
}
void handleJsonError(JsonDocument& jsonError) {
char message[255];
serializeJson(jsonError, message);
Mqtt::publish(RAW_TOPIC, message);
}
}
// {"rcSwitch":{"protocol":1,"state":false,"group":"11111","channel":4}}

70
include/output.h Normal file
View File

@ -0,0 +1,70 @@
static const char* bin2tristate(const char* bin);
static char * dec2binWzerofill(unsigned long Dec, unsigned int bitLength);
void output(unsigned long decimal, unsigned int length, unsigned int delay, unsigned int* raw, unsigned int protocol) {
const char* b = dec2binWzerofill(decimal, length);
Serial.print("Decimal: ");
Serial.print(decimal);
Serial.print(" (");
Serial.print( length );
Serial.print("Bit) Binary: ");
Serial.print( b );
Serial.print(" Tri-State: ");
Serial.print( bin2tristate( b) );
Serial.print(" PulseLength: ");
Serial.print(delay);
Serial.print(" microseconds");
Serial.print(" Protocol: ");
Serial.println(protocol);
Serial.print("Raw data: ");
for (unsigned int i=0; i<= length*2; i++) {
Serial.print(raw[i]);
Serial.print(",");
}
Serial.println();
Serial.println();
}
static const char* bin2tristate(const char* bin) {
static char returnValue[50];
int pos = 0;
int pos2 = 0;
while (bin[pos]!='\0' && bin[pos+1]!='\0') {
if (bin[pos]=='0' && bin[pos+1]=='0') {
returnValue[pos2] = '0';
} else if (bin[pos]=='1' && bin[pos+1]=='1') {
returnValue[pos2] = '1';
} else if (bin[pos]=='0' && bin[pos+1]=='1') {
returnValue[pos2] = 'F';
} else {
return "not applicable";
}
pos = pos+2;
pos2++;
}
returnValue[pos2] = '\0';
return returnValue;
}
static char * dec2binWzerofill(unsigned long Dec, unsigned int bitLength) {
static char bin[64];
unsigned int i=0;
while (Dec > 0) {
bin[32+i++] = ((Dec & 1) > 0) ? '1' : '0';
Dec = Dec >> 1;
}
for (unsigned int j = 0; j< bitLength; j++) {
if (j >= bitLength - i) {
bin[j] = bin[ 31 + i - (j - (bitLength - i)) ];
} else {
bin[j] = '0';
}
}
bin[bitLength] = '\0';
return bin;
}

12
include/pins.h Normal file
View File

@ -0,0 +1,12 @@
#pragma once
#if defined(ESP8266)
#define SEND_PIN 14
#define RECEIVE_PIN 12
#define RED_LED LED_BUILTIN
#define BLUE_LED 2
#else
#define RESET_PIN 10
#define SEND_PIN 11
#define RECEIVE_PIN 2
#endif

32
include/pro-mini.h Normal file
View File

@ -0,0 +1,32 @@
#include "output.h"
namespace Board {
void setup() {
digitalWrite(RESET_PIN, HIGH);
pinMode(RESET_PIN, OUTPUT);
}
void readCommand() {
if (serialReader.readLine(Serial) > 0) {
char* cmd = serialReader.getBuffer();
if (strcmp("reset", cmd) == 0) {
Serial.println("resetting...");
delay(1200);
digitalWrite(RESET_PIN, LOW);
Serial.println("resetting failed");
}
runJsonCommand(cmd);
}
}
void loop() {
readCommand();
}
void publishResponse(JsonDocument& jsonDoc) {
}
void handleJsonError(JsonDocument& jsonError) {
}
}

95
include/rc_devices.h Normal file
View File

@ -0,0 +1,95 @@
#pragma once
#define MAIN_DEVICE_ID "rc-gateway"
#define BATTERY_PERCENTAGE_TEMPLATE(min, diff) "{% if value_json.sensor.diagnostic.voltage|is_number %}\
{{ ((value_json.sensor.diagnostic.voltage|float-" #min ")|round(2)*100/" #diff ")|int }}\
{% endif %}"
#include "esp.h"
#include "ha.h"
using namespace Ha;
typedef unordered_multimap<uint32_t, Ha::Switch*> mapswitches;
mapswitches onSwitches;
mapswitches offSwitches;
unordered_map<string, Ha::Switch*> p1Switches;
auto gatewayDevice = &DeviceConfig::create(MAIN_DEVICE_ID).withName("RC Gateway").withManufacturer("Adafruit").withModel("Huzzah Esp8266");
struct PollinSwitch : Switch {
constexpr static const char* man = "Pollin";
const char* group;
uint8_t channel;
PollinSwitch(const char* group, const uint8_t channel, const char* name = nullptr, const char* area = nullptr)
: Switch(nullptr, [group, channel]{
// copy id from string into a new pointer, to avoid memory leaks
return (new string{Protocol_1::buildId(group, channel)})->c_str();
}()), group(group), channel(channel) { // cppcheck-suppress [selfInitialization]
if (!name) name = (new string{string(man).append(" ").append(id)})->c_str();
entityId = [this]() {
auto eId = string{man};
transform(eId.begin(), eId.end(), eId.begin(), ::tolower);
return (new string{eId.append("_").append(id)})->c_str();
}();
mainDevice = &DeviceConfig::create(id).withName(name).withManufacturer(man).withArea(area).withParent(gatewayDevice);
withStateTopic();
deviceClass = "outlet";
p1Switches.insert({ string(id), this });
}
void onCommand(const char* msg) override {
strcmp("ON", msg) == 0 ? mySwitch.switchOn(group, channel) : mySwitch.switchOff(group, channel);
publisher(State::topic, msg);
}
};
struct EasyHomeSwitch : Switch {
constexpr static const array<uint32_t, 4> onAll = { 4326554, 4537114, 4767530, 4972714 };
constexpr static const array<uint32_t, 4> offAll = { 4483146, 4626810, 4661562, 4819642 };
array<uint32_t, 4> onButton;
array<uint32_t, 4> offButton;
EasyHomeSwitch(const char remotePosition, array<uint32_t, 4> on, array<uint32_t, 4> off, const char* name = nullptr, const char* area = nullptr)
: Switch(nullptr, [remotePosition] {
auto uId = new string("easy_home_");
(*uId) += tolower(remotePosition);
return uId->c_str();
}()), onButton(on), offButton(off) {
if (!name) {
auto n = new string("Easy Home ");
(*n) += remotePosition;
name = n->c_str();
}
entityId = id;
mainDevice = &DeviceConfig::create(id).withName(name).withManufacturer("Intertek").withModel("Easy Home").withArea(area).withParent(gatewayDevice);
withStateTopic();
deviceClass = "outlet";
for (int i = 0; i < 4; i++) {
onSwitches.insert({ onAll[i], this });
onSwitches.insert({ onButton[i], this });
offSwitches.insert({ offAll[i], this });
offSwitches.insert({ offButton[i], this });
}
}
void onCommand(const char* msg) override {
mySwitch.setProtocol(4);
strcmp("ON", msg) == 0 ? mySwitch.send(onButton[0], 24) : mySwitch.send(offButton[0], 24);
publisher(State::topic, msg);
}
};
template <class T>
auto batterySensors(const char* id, const char* batterySensorTemplate) {
return [id, batterySensorTemplate](Builder<T>& builder) -> Builder<T>& {
builder
.addDiagnostic(new VoltageSensor{id, "Battery voltage", "{{ value_json.sensor.diagnostic.voltage }}"})
.addDiagnostic(new BatterySensor{id, "Battery level", batterySensorTemplate})
.build();
return builder;
};
}

Some files were not shown because too many files have changed in this diff Show More