diff --git a/Code/Arduino/HanReader/src/Aidon.h b/Arduino Code/Arduino Libraries/HanReader/src/Aidon.h similarity index 100% rename from Code/Arduino/HanReader/src/Aidon.h rename to Arduino Code/Arduino Libraries/HanReader/src/Aidon.h diff --git a/README.md b/README.md index 55c7123e..e418f291 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,3 @@ ->!!! NOTE !!! ->I am currently editing this fork to focus on the 'HAN_ESP_TSS721' board which is complete, but needs some minor work with the software to make it more user friendly. ->I'm organizing the files differently to separate simulators and HAN documentation, deleting theme-related files which aren't necessary for functionality etc. so it's easier to get the files you need for creating one yourself, without worrying about the development documentation. -> ->There will be tutorial for ordering, assembly and for uploding software, which would make this project more approachable for everyone interested. ->Later on the PCB might be redesigned to use less SMD parts to be more soldering friendly. - # AMS <-> MQTT Bridge This project may help you build your own reader for HAN data streamed from the new AMS electrical meters installed in Norway in 2017/2018. Data is read using an Arduino-programmed ESP8266 (in an ESP12 module from AI Thinker), then pushed to MQTT over WiFi. You can have full control over this data, and you can basically do anything with it. @@ -13,15 +6,15 @@ *Building this project will require some skills in ordering and assembling electronic circuits as well as programming, and I have not included detailed instructions to take a beginner through the steps. I still hope some still find information here useful, maybe also for other projects.* ## The completed hardware -![The HAN Reader Hardware](./Electrical/HAN_ESP_TSS721/images/HanReaderInEnclosure.PNG) +![The HAN Reader Hardware](./Images/HanReaderInEnclosure.PNG) *The completed board mounted in a [3D printed enclosure](/Electrical/HAN_ESP_TSS721/enclosure)* -![The HAN Reader Installed](./Electrical/HAN_ESP_TSS721/images/HanReaderConnected.PNG) +![The HAN Reader Installed](./Images/HanReaderConnected.PNG) *...installed with the electrical meter...* -![Data from MQTT displayed on a Node Red Dashboard](./logo/NodeRedScreen.PNG) +![Data from MQTT displayed on a Node Red Dashboard](./Images/NodeRedScreen.PNG) *...and, showing data on a [Node Red](https://nodered.org/) dashboard* @@ -31,29 +24,29 @@ The purpose of this project is to collect information and build a simplified bri Components will be ESP8622, Arduino code and an M-bus <-> 3.3V serial interface -As a start, we should try to get information from the three types of AMS meters currently being installed in Norway. Some details about these are available here: [NVE_Info_kunder_HANgrensesnitt.pdf](Documentation/NVE_Info_kunder_HANgrensesnitt.pdf) +As a start, we should try to get information from the three types of AMS meters currently being installed in Norway. Some details about these are available here: [NVE_Info_kunder_HANgrensesnitt.pdf](./Debugging/Documentation/NVE_Info_kunder_HANgrensesnitt.pdf) Quite some work was put into parse and guess how the data protocol was defined. Unfortunately, I did not have access to the (rather expensive) standardization documentation, but with some collaborative effort we solved most details. ### This project includes -- [X] [Circuit to read MBus data, parse the DSLM and report to MQTT over WiFi](/Electrical/HAN_ESP_TSS721) -- [X] [Code to capture and analyze data from a PC](./Code/HanDebugger) -- [X] [Code to capture and analyze data from Arduino](./Code/ESPDebugger) -- [X] [Sample data from various meters](./Samples) -- [X] [Documentation on HAN / MBus / DLMS/COSEM](./Documentation) -- [X] [Code to parse DLMS data into a structure](./Code/Arduino/HanReader/src) -- [X] [Real schematics, including ESP8266](./Electrical/HAN_ESP_TSS721#schematics) -- [X] [PCB layout](./Electrical/HAN_ESP_TSS721#pcb) -- [X] [Component list](./Electrical/HAN_ESP_TSS721#componenet-list) -- [X] [Arduino library](./Code/Arduino) -- [X] [Complete Arduino sketch to read values and report to MQTT server](./Code/Arduino/AmsToMqttBridge) +- [X] [Circuit to read MBus data, parse the DSLM and report to MQTT over WiFi](./PCB/KiCAD/HAN_ESP_TSS721) +- [X] [Code to capture and analyze data from a PC](./Debugging/Code/HanDebugger) +- [X] [Code to capture and analyze data from Arduino](./Debugging/Code/ESPDebugger) +- [X] [Sample data from various meters](./Debugging/Samples) +- [X] [Documentation on HAN / MBus / DLMS/COSEM](./Debugging/Documentation) +- [X] [Code to parse DLMS data into a structure](./Arduino Code/Arduino Libraries/HanReader/src) +- [X] [Real schematics, including ESP8266](./PCB/KiCAD/HAN_ESP_TSS721#schematics) +- [X] [PCB layout](./PCB/KiCAD/HAN_ESP_TSS721#pcb) +- [X] [Component list](./PCB/KiCAD/HAN_ESP_TSS721#componenet-list) +- [X] [Arduino library](./Arduino Code) +- [X] [Complete Arduino sketch to read values and report to MQTT server](./Arduino Code/AmsToMqttBridge) -[The completed project](./Code/Arduino/AmsToMqttBridge) also includes: +[The completed project](./Arduino Code/AmsToMqttBridge) also includes: - Boot as Access Point and web server to allow config from a web browser. This allows you to set SSID, password, MQTT server and port, as well as topics for publish and subscribe - On-board temperature sensor, also reported in json to MQTT ## Electrical design -The [most recent design](/Electrical/HAN_ESP_TSS721) uses an [ESP8266](http://esp8266.net/) in an ESP12 module from [AI Thinker](https://www.ai-thinker.com) for micro processing and the [TSS721](http://www.ti.com/product/TSS721A) from Texas Instruments for level conversion from M-Bus to TTL (3.3V). An earlier design solved the level conversion using an op-amp, which might be an easier and more available solution, but also more error-prone. See more details in [electrical design](./Electrical). +The [most recent design](/PCB/KiCAD/HAN_ESP_TSS721) uses an [ESP8266](http://esp8266.net/) in an ESP12 module from [AI Thinker](https://www.ai-thinker.com) for micro processing and the [TSS721](http://www.ti.com/product/TSS721A) from Texas Instruments for level conversion from M-Bus to TTL (3.3V). An earlier design solved the level conversion using an op-amp, which might be an easier and more available solution, but also more error-prone. See more details in [electrical design](./Electrical). diff --git a/Samples/Aidon/output.txt b/Samples/Aidon/output.txt deleted file mode 100644 index e69de29b..00000000