-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3e87450
commit 71cecae
Showing
1 changed file
with
129 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| # MBusPico | ||
|
|
||
| [](https://www.gnu.org/licenses/gpl-3.0) | ||
|
|
||
| This project was created mostly out of interest and the wish to read out and display my power meter data in my Loxone smart home setup. (Thus the option with the 24V power supply - see below) | ||
|
|
||
| Currently the only smart meter device supported is the **Kaifa MA309M** (austrian provider Netz NÖ/EVN), but could be extended to any other model. Credits for the data intepretation code goes out to **[firegore/esphome-dlms-meter](https://github.com/firegore/esphome-dlms-meter)**! | ||
|
|
||
| The read meter data is published via HTTP and/or UDP in JSON format: | ||
|
|
||
| ``` | ||
| { | ||
| "timestamp": "2022-11-17T00:13:55Z", | ||
| "meterNumber": "123456789012", | ||
| "activePowerPlus": 472.00, | ||
| "activePowerMinus": 0.00, | ||
| "activeEnergyPlus": 1385960.00, | ||
| "activeEnergyMinus": 0.00, | ||
| "voltageL1": 235.00, | ||
| "voltageL2": 234.30, | ||
| "voltageL3": 235.00, | ||
| "currentL1": 1.72, | ||
| "currentL2": 0.17, | ||
| "currentL3": 0.99, | ||
| "powerFactor": 823.00 | ||
| } | ||
| ``` | ||
|
|
||
| ## Hardware | ||
|
|
||
| * [RaspberryPi Pico W(H)](https://amzn.to/3OlR064) | ||
| * [M-BUS SLAVE CLICK module](https://www.mikroe.com/m-bus-slave-click) | ||
| * [RJ11/RJ12 cable](https://amzn.to/3TSGO6r) | ||
| * Optional (only if you plan to connect a 24V power source) | ||
| * [24V -> 5V step down regulator](https://www.pololu.com/product/2831) [Shop link](https://www.berrybase.at/pololu-5v-1a-step-down-spannungsregler-d24v10f5) | ||
| * [power connector clamp](https://www.berrybase.at/anschlussklemme-schraubbar-900-gewinkelt-1-25mm2-rm-5-08mm-2-polig) | ||
|
|
||
| *Note*: the links of the above listed hardware components to Amazon are exemplary. If you want to support me you can use them to order the linked products using these links. | ||
|
|
||
| ## Software | ||
|
|
||
| The software for the Pico W microcontroller is written in C using | ||
| * pico-sdk | ||
| * FreeRTOS | ||
| * mbedtls | ||
|
|
||
| ## Build | ||
| ### LINUX | ||
| ```console | ||
| mkdir build | ||
| cd build | ||
| cmake .. -DCMAKE_BUILD_TYPE=Release \ | ||
| -DMBUSPICO_WIFI_ENABLED=ON -DMBUSPICO_WIFI_SSID="My Wifi SSID" -DMBUSPICO_WIFI_PWD="12345678" -DMBUSPICO_WIFI_HOSTNAME="MeterReaderPico" \ | ||
| -DMBUSPICO_UDP_ENABLED=ON -DMBUSPICO_UDP_RECEIVER_HOST="192.168.0.99" -DMBUSPICO_UDP_RECEIVER_PORT=3333 \ | ||
| -DMBUSPICO_HTTP_ENABLED=ON -DMBUSPICO_HTTP_SERVER_PORT=8888 \ | ||
| -DMBUSPICO_DEVICE_KEY="36C66639E48A8CA4D6BC8B282A793BBB" | ||
| cmake --build . | ||
| ``` | ||
|
|
||
| Make sure you have set the `PICO_SDK_PATH` environment variable pointing to your local pico-sdk checkout. | ||
| If you do not have a checkout of the pico-sdk yet, you can instead add the option `-DPICO_SDK_FETCH_FROM_GIT=ON` to the build command above to automatically checkout the pico-sdk as part of the build process. | ||
|
|
||
| ### WINDOWS | ||
|
|
||
| For Windows i would recommend using Docker for a quick and painless build. | ||
|
|
||
| Create a (local) docker image with the file provided in the `docker` folder of this repository: | ||
| ```console | ||
| docker build -t mbuspico/build -f docker/Dockerfile | ||
| ``` | ||
| After the build of the docker image has finished (might take a few minutes) start the built docker image and execute the same build command from above (the built docker image already contains the pico-sdk): | ||
| ```console | ||
| docker run -it --rm -v ${PWD}:/opt/mbuspico mbuspico/build | ||
| ... | ||
| > cd /opt/mbuspico | ||
| > mkdir build | ||
| > cd build | ||
| cmake .. -DCMAKE_BUILD_TYPE=Release -D... | ||
| ``` | ||
|
|
||
| Hold the button on the Pico W while connecting it to the PC via a USB cable. The Pico will show up as a flash drive. Copy the `mbuspico.uf2` file to the appeared flash drive. The Pico W will automatically reboot into the just flashed firmware after copying has finished. Done. | ||
|
|
||
| ### Build options | ||
|
|
||
| | **Option** | Default value | **required** | **Description** | | ||
| | --------------------- | ------------- | ----------------------- | --------------- | | ||
| | MBUSPICO_DEVICE_KEY | | yes / device dependant | Key used to decrypt data read from the meter. Must be requested from the power provider. | | ||
| | MBUSPICO_LOG_LEVEL | LOG_ERROR | no | level of log verbosity. Possible values: LOG_NONE, LOG_ERROR, LOG_INFO, LOG_DEBUG | | ||
| | MBUSPICO_WIFI_ENABLED | ON | no | specifies if the device should connect to wifi network | | ||
| | MBUSPICO_WIFI_SSID | | yes, if MBUSPICO_WIFI_ENABLED | Wifi SSID to connect to | | ||
| | MBUSPICO_WIFI_PWD | | yes, if MBUSPICO_WIFI_ENABLED | Wifi password | | ||
| | MBUSPICO_WIFI_HOSTNAME | "MBusPico" | no | The hostname of the Pico W device in the network | | ||
| | MBUSPICO_UDP_ENABLED | OFF | no | specifies if the device should send out the read meter data via UDP | | ||
| | MBUSPICO_UDP_RECEIVER_HOST | | yes, if MBUSPICO_UDP_ENABLED | the UDP receiver address the meter data packet should be send to | | ||
| | MBUSPICO_UDP_RECEIVER_PORT | | yes, if MBUSPICO_UDP_ENABLED | the UDP receiver port the meter data packet should be send to | | ||
| | MBUSPICO_UDP_INTERVAL_S | 30 | no | the maximum interval [sec] the meter data should be send out via UDP | | ||
| | MBUSPICO_HTTP_ENABLED | ON | no | specifies if the device should launch a simple HTTP server to provide the read meter data | | ||
| | MBUSPICO_HTTP_SERVER_PORT | 80 | no | specifies the listening port for the HTTP webserver | | ||
|
|
||
| # Hardware wiring / assembly | ||
|
|
||
| See the tables below how to wire the Raspberry Pico W with the used hware components and power supply. | ||
|
|
||
| | **Pico W** | **M-Bus Slave CLICK** | **RJ11** | **Notes** | | ||
| | --------------- | ----------------------- | -------- | --------- | | ||
| | 3.3V (PIN 36) | 3V3 | - | 3.3V power supply | | ||
| | GND (PIN 8) | GND | - | Ground | | ||
| | GPIO4 (PIN 6) | RX | - | UART RX of MBUS module <--> UART1 TX of Pico W | | ||
| | GPIO5 (PIN 7) | TX | - | UART TX of MBUS module <--> UART1 RX of Pico W | | ||
| | - | MBUS1 | 3 | MBUS module to RJ11 cable line 3 or 4, polarity does not matter | | ||
| | - | MBUS2 | 4 | MBUS module to RJ11 cable line 3 or 4, polarity does not matter | | ||
|
|
||
| additionally with optional 24V adapter: | ||
|
|
||
| | **Pico W** | **24V-->5V module** | **24V power source** | **Notes** | | ||
| | --------------- | ----------------------- | -------------------- | --------- | | ||
| | VSYS (PIN 39) | VOUT | - | 5V power supply for Pico W | | ||
| | GND (PIN 38) | - | DC-/GND | Ground | | ||
| | - | VIN | DC+/24V | 24V external power supply | | ||
| | - | GND | DC-/GND | Ground | | ||
|
|
||
| ## 3D printer files | ||
|
|
||
| I created a 3d printable *reference design* of a case for the used hardware components listed above. | ||
| You can find the files in the `3d` folder of this repository. | ||
|
|
||
| ## License | ||
|
|
||
| Licensed under [GPLv3](https://github.com/raven-worx/loveboxpi/blob/master/LICENSE) |