├── .gitignore ├── .travis.yml ├── CHANGELOG.md ├── LICENSE ├── README.md ├── doc ├── assets │ ├── SMLReader_Img_D1.jpg │ ├── SMLReader_Img_ReadingHead.jpg │ ├── SMLReader_Img_ReadingHead_Close.jpg │ └── SMLReader_Schema.png ├── samples │ └── influxdb_grafana │ │ ├── .env │ │ ├── docker-compose.yaml │ │ └── telegraf │ │ └── telegraf.conf ├── screenshots │ ├── screenshot_grafana.png │ ├── screenshot_mqtt.png │ ├── screenshot_platformio_build.png │ ├── screenshot_platformio_upload.png │ ├── screenshot_platformio_upload_and_monitor.png │ └── screenshot_setup.png └── src │ └── SMLReader.fzz ├── include └── README ├── lib └── README ├── platformio.ini ├── src ├── MqttPublisher.h ├── Sensor.h ├── config.h ├── debug.h ├── main.cpp └── unit.h └── test └── README /.gitignore: -------------------------------------------------------------------------------- 1 | .pio 2 | .pioenvs 3 | .piolibdeps 4 | .vscode/ 5 | 6 | # Mac stuff 7 | .DS_Store 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # Continuous Integration (CI) is the practice, in software 2 | # engineering, of merging all developer working copies with a shared mainline 3 | # several times a day < https://docs.platformio.org/page/ci/index.html > 4 | # 5 | # Documentation: 6 | # 7 | # * Travis CI Embedded Builds with PlatformIO 8 | # < https://docs.travis-ci.com/user/integration/platformio/ > 9 | # 10 | # * PlatformIO integration with Travis CI 11 | # < https://docs.platformio.org/page/ci/travis.html > 12 | # 13 | # * User Guide for `platformio ci` command 14 | # < https://docs.platformio.org/page/userguide/cmd_ci.html > 15 | # 16 | # 17 | # Please choose one of the following templates (proposed below) and uncomment 18 | # it (remove "# " before each line) or use own configuration according to the 19 | # Travis CI documentation (see above). 20 | # 21 | 22 | 23 | # 24 | # Template #1: General project. Test it using existing `platformio.ini`. 25 | # 26 | 27 | # language: python 28 | # python: 29 | # - "2.7" 30 | # 31 | # sudo: false 32 | # cache: 33 | # directories: 34 | # - "~/.platformio" 35 | # 36 | # install: 37 | # - pip install -U platformio 38 | # - platformio update 39 | # 40 | # script: 41 | # - platformio run 42 | 43 | 44 | # 45 | # Template #2: The project is intended to be used as a library with examples. 46 | # 47 | 48 | # language: python 49 | # python: 50 | # - "2.7" 51 | # 52 | # sudo: false 53 | # cache: 54 | # directories: 55 | # - "~/.platformio" 56 | # 57 | # env: 58 | # - PLATFORMIO_CI_SRC=path/to/test/file.c 59 | # - PLATFORMIO_CI_SRC=examples/file.ino 60 | # - PLATFORMIO_CI_SRC=path/to/test/directory 61 | # 62 | # install: 63 | # - pip install -U platformio 64 | # - platformio update 65 | # 66 | # script: 67 | # - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N 68 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 | 7 | ## [2.3.0] - 2023-03-14 8 | ### Changed 9 | - Upgraded IotWebConf to version 3 10 | ### Fixed 11 | - [Issue #47](https://github.com/mruettgers/SMLReader/issues/47), Broken MQTT reconnect after WiFi disconnect 12 | 13 | ## [2.2.1] - 2022-03-17 14 | ### Changed 15 | - [Issue #19](https://github.com/mruettgers/SMLReader/issues/19) 16 | ### Fixed 17 | - The max length of the WiFi password has been increased to 64 chars 18 | 19 | ## [2.2.0] - 2021-05-04 20 | ### Changed 21 | - Replaced MQTT client library with [Pangolin MQTT Client](https://github.com/philbowles/PangolinMQTT) 22 | - Refactored throttling logic 23 | ### Fixed 24 | - [Issue #15](https://github.com/mruettgers/SMLReader/issues/15) 25 | 26 | ## [2.1.6] - 2021-01-03 27 | ### Added 28 | - Configuration option to allow setting an inverval for throttling the MQTT messages 29 | ### Fixed 30 | - Locked third party dependency IotWebConf to version 2 due to incompatible changes in version 3 31 | 32 | ## [2.1.5] - 2020-07-25 33 | ### Changed 34 | - Modified MQTT topic to use / instead of * due to invalid character issues when used with ioBroker 35 | 36 | ## [2.1.4] - 2020-07-24 37 | ### Changed 38 | - Worked on the docs 39 | - Added LED based feedback for SML data recognition 40 | 41 | ## [2.1.3] - 2020-04-17 42 | ### Changed 43 | - Added hint to change AP password to the docs 44 | - Moved WiFi default settings to `config.h` 45 | ### Fixed 46 | - String initialization issues resulting in random MQTT username/passqord in UI 47 | 48 | ## [2.1.2] - 2020-04-16 49 | ### Changed 50 | - Updated the docs 51 | - Read (and in debug mode print out) sensor values even without an active wifi connection 52 | 53 | ## [2.1.1] - 2020-04-15 54 | ### Changed 55 | - Fixed MQTT topic to include the whole OBIS identifier 56 | - Look for a reading head attached to GPIO pin D2 by default 57 | - Switched to official libSML repository 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SMLReader 2 | 3 | An ESP8266 based smart meter (SML) to MQTT gateway 4 | 5 | ## About 6 | 7 | The aim of this project is to read the meter readings of modern energy meters and make them available via MQTT. 8 | 9 | The software was primarily developed and tested for the EMH ED300L electricity meter, but should also work with other energy meters that have an optical interface and communicate via the SML protocol. 10 | 11 | SMLReader publishes the metrics read from the meter's optical unit to an MQTT broker configured via the provided web interface. 12 | 13 | If you like this project, you might consider to [support me](#donate). 14 | 15 | ### Screenshots 16 | ![WiFi and MQTT setup](doc/screenshots/screenshot_setup.png) 17 | ![Grafana](doc/screenshots/screenshot_grafana.png) 18 | ```bash 19 | MB-Monty ➜ ~ mosquitto_sub -h 10.4.32.103 -v -t smartmeter/mains/# 20 | smartmeter/mains/info Hello from 00C7551E, running SMLReader version 2.1.5. 21 | smartmeter/mains/sensor/1/obis/1-0:1.8.0/255/value 3546245.9 22 | smartmeter/mains/sensor/1/obis/1-0:2.8.0/255/value 13.2 23 | smartmeter/mains/sensor/1/obis/1-0:1.8.1/255/value 0.0 24 | smartmeter/mains/sensor/1/obis/1-0:2.8.1/255/value 13.2 25 | smartmeter/mains/sensor/1/obis/1-0:1.8.2/255/value 3546245.9 26 | smartmeter/mains/sensor/1/obis/1-0:2.8.2/255/value 0.0 27 | smartmeter/mains/sensor/1/obis/1-0:16.7.0/255/value 451.2 28 | ``` 29 | 30 | ### Hardware 31 | 32 | #### Reading head 33 | 34 | The reading head consists of a phototransistor (BPW 40) and a 1 kΩ pull-up resistor connected to one of the GPIO pins of the microcontroller. 35 | Other phototransistors or the use of an internal pull-up resistor will probably work, too. 36 | 37 | The housing of my reading head has been 3D-printed using the [STL files](http://www.stefan-weigert.de/php_loader/sml.php) from [Stefan Weigert](http://www.stefan-weigert.de). 38 | 39 | A ring magnet (in my case dimensioned 27x21x3mm) ensures that the reading head keeps stuck on the meter. 40 | 41 | The phototransistor has been fixed with hot glue within the housing. 42 | 43 | ![Reading Head](doc/assets/SMLReader_Img_ReadingHead.jpg "Reading Head") ![Reading Head](doc/assets/SMLReader_Img_ReadingHead_Close.jpg "Reading Head") ![D1](doc/assets/SMLReader_Img_D1.jpg "WeMos D1 mini") 44 | 45 | #### Schematic diagram 46 | ![Schematic diagram](doc/assets/SMLReader_Schema.png) 47 | 48 | ## Getting started 49 | 50 | To get started, the software must first somehow get onto the device. 51 | This can be done in several ways. 52 | 53 | ### Uploading a precompiled binary 54 | 55 | A precompiled binary for the Wemos D1 and configured to have a sensor attached to pin D2 can be downloaded from the releases page on GitHub: 56 | 57 | [https://github.com/mruettgers/SMLReader/releases](https://github.com/mruettgers/SMLReader/releases) 58 | 59 | #### Flashing 60 | 61 | This precompiled binary can be flashed to the device with the help of [esptool.py](https://github.com/espressif/esptool). 62 | Other tools should also work, as long as you have configured them to match the specs of your ESP8266. 63 | 64 | ```bash 65 | esptool.py --port /dev/ttyUSB0 write_flash -fm dout 0x00000 path/to/smlreader.bin 66 | ``` 67 | 68 | As a docker enthusiast I prefer to utilize a dockerized version of esptool.py by bind-mounting the current working directory to `/src` and assuming that `smlreader.bin` is existing in the current working directory: 69 | ```bash 70 | docker run -it --device /dev/ttyUSB0 -v $(pwd):/src --rm mruettgers/esptool --port /dev/ttyUSB0 write_flash -fm dout 0x00000 /src/smlreader.bin 71 | ``` 72 | 73 | The device path and the path to the binary have to be adjusted to fit your needs. 74 | 75 | 76 | ##### Example 77 | 78 | ```bash 79 | nb-ubuntu ➜ ~/Downloads ls SMLReader_D1mini_v2.1.3.bin 80 | SMLReader_D1mini_v2.1.3.bin 81 | 82 | nb-ubuntu ➜ ~/Downloads docker run -it --device=/dev/ttyUSB0 -v $(pwd):/src --rm mruettgers/esptool --port /dev/ttyUSB0 write_flash -fm dout 0x00000 /src/SMLReader_D1mini_v2.1.3.bin 83 | esptool.py v2.8 84 | Serial port /dev/ttyUSB0 85 | Connecting.... 86 | Detecting chip type... ESP8266 87 | Chip is ESP8266EX 88 | Features: WiFi 89 | Crystal is 26MHz 90 | MAC: d8:f1:5b:07:0d:eb 91 | Uploading stub... 92 | Running stub... 93 | Stub running... 94 | Configuring flash size... 95 | Auto-detected Flash size: 4MB 96 | Flash params set to 0x0340 97 | Compressed 378528 bytes to 266738... 98 | Wrote 378528 bytes (266738 compressed) at 0x00000000 in 23.6 seconds (effective 128.1 kbit/s)... 99 | Hash of data verified. 100 | 101 | Leaving... 102 | Hard resetting via RTS pin... 103 | ``` 104 | 105 | --- 106 | 107 | ### Using your IDE for building and flashing 108 | 109 | You should be able to use your preferred IDE to build and flash SMLReader if you take care of the dependencies and the build flags configured in the `platform.io` file. 110 | I strongly recommend using PlatformIO as it takes care of that itself. 111 | 112 | #### Configuration 113 | 114 | The configuration of the reading heads is done by editing `src/config.h` and adjusting `SENSOR_CONFIGS` (see below). 115 | 116 | ```c++ 117 | static const SensorConfig SENSOR_CONFIGS[] = { 118 | {.pin = D2, // GPIO pin of the phototransistor 119 | .name = "1", // Sensor name used in MQTT topic 120 | .numeric_only = false, // If "true", only numeric values are being published via MQTT 121 | .status_led_enabled = true, // Flash status LED (3 times) when an SML start sequence has been found 122 | .status_led_inverted = true, // Some LEDs (like the ESP8266 builtin LED) require an inverted output signal 123 | .status_led_pin = LED_BUILTIN, // GPIO pin used for sensor status LED 124 | .interval = 0 // If greater than 0, messages are published every [interval] seconds 125 | }, 126 | {.pin = D5, 127 | .name = "2", 128 | .numeric_only = false, 129 | .status_led_enabled = true, 130 | .status_led_inverted = true, 131 | .status_led_pin = LED_BUILTIN, 132 | .interval = 0 133 | }, 134 | {.pin = D6, 135 | .name = "3", 136 | .numeric_only = false, 137 | .status_led_enabled = true, 138 | .status_led_inverted = true, 139 | .status_led_pin = LED_BUILTIN, 140 | .interval = 15 141 | } 142 | }; 143 | ``` 144 | 145 | 146 | #### Building 147 | 148 | Building SMLReader in PlatformIO is straight forward and can be done by executing the build task matching your environment (i.e. `d1_mini`). 149 | 150 | In case you get the following error, it is time to install a Git client (https://git-scm.com/downloads) and to make sure that the path to `git` is covered by the PATH variable and `git` is thus executable from everywhere. 151 | 152 | ``` 153 | UserSideException: Please install Git client from https://git-scm.com/downloads: 154 | File "/home/monty/.platformio/penv/lib/python3.8/site-packages/platformio/builder/main.py", line 168: 155 | env.SConscript("$BUILD_SCRIPT") 156 | ``` 157 | 158 | ![Building with PlatformIO](doc/screenshots/screenshot_platformio_build.png) 159 | 160 | 161 | #### Flashing 162 | 163 | ![Flashing with PlatformIO](doc/screenshots/screenshot_platformio_upload.png) 164 | 165 | --- 166 | 167 | 168 | ### Running 169 | 170 | WiFi and MQTT are configured via the web interface provided by [IotWebConf](https://github.com/prampec/IotWebConf) and which can be reached after joining the WiFi network named SMLReader and heading to http://192.168.4.1. 171 | If the device has already been configured, the web interface can be reached via the IP address obtained from your local network's DHCP server. 172 | To login provide the user `admin` and the configured AP password. 173 | 174 | *Attention: You have to change the AP Password (empty by default), otherwise SMLReader won't work.* 175 | 176 | If everything is configured properly and running with a sensor in place, SMLReader will publish the metrics and values received from the meter to the configured MQTT broker: 177 | 178 | ``` 179 | MB-Monty ➜ ~ mosquitto_sub -h 10.4.32.103 -v -t smartmeter/mains/# 180 | smartmeter/mains/info Hello from 00C7551E, running SMLReader version 2.1.5. 181 | smartmeter/mains/sensor/1/obis/1-0:1.8.0/255/value 3546245.9 182 | smartmeter/mains/sensor/1/obis/1-0:2.8.0/255/value 13.2 183 | smartmeter/mains/sensor/1/obis/1-0:1.8.1/255/value 0.0 184 | smartmeter/mains/sensor/1/obis/1-0:2.8.1/255/value 13.2 185 | smartmeter/mains/sensor/1/obis/1-0:1.8.2/255/value 3546245.9 186 | smartmeter/mains/sensor/1/obis/1-0:2.8.2/255/value 0.0 187 | smartmeter/mains/sensor/1/obis/1-0:16.7.0/255/value 451.2 188 | 189 | smartmeter/mains/sensor/2/obis/1-0:1.8.0/255/value 3546245.9 190 | smartmeter/mains/sensor/2/obis/1-0:2.8.0/255/value 13.2 191 | smartmeter/mains/sensor/2/obis/1-0:1.8.1/255/value 0.0 192 | smartmeter/mains/sensor/2/obis/1-0:2.8.1/255/value 13.2 193 | smartmeter/mains/sensor/2/obis/1-0:1.8.2/255/value 3546245.9 194 | smartmeter/mains/sensor/2/obis/1-0:2.8.2/255/value 0.0 195 | smartmeter/mains/sensor/2/obis/1-0:16.7.0/255/value 451.2 196 | 197 | smartmeter/mains/sensor/3/obis/1-0:1.8.0/255/value 3546245.9 198 | smartmeter/mains/sensor/3/obis/1-0:2.8.0/255/value 13.2 199 | smartmeter/mains/sensor/3/obis/1-0:1.8.1/255/value 0.0 200 | smartmeter/mains/sensor/3/obis/1-0:2.8.1/255/value 13.2 201 | smartmeter/mains/sensor/3/obis/1-0:1.8.2/255/value 3546245.9 202 | smartmeter/mains/sensor/3/obis/1-0:2.8.2/255/value 0.0 203 | smartmeter/mains/sensor/3/obis/1-0:16.7.0/255/value 451.2 204 | ``` 205 | 206 | --- 207 | 208 | 209 | ### Debugging 210 | 211 | Serial logging can be enabled by setting `SERIAL_DEBUG=true` in the `platformio.ini` file before building. 212 | To increase the log level and to get the raw SML data, also set `SERIAL_DEBUG_VERBOSE=true`. 213 | 214 | #### Serial port monitor 215 | 216 | A serial port monitor can be attached using the corresponding function of your IDE or by invoking a terminal client like `miniterm` which comes shipped with `python-serial`. 217 | The serial port settings are `115200,8,N,1`. 218 | 219 | ##### miniterm.py 220 | 221 | ```bash 222 | miniterm /dev/ttyUSB0 115200 223 | ``` 224 | 225 | ###### Example 226 | 227 | ```bash 228 | nb-ubuntu ➜ ~/Downloads miniterm /dev/ttyUSB0 115200 229 | --- Miniterm on /dev/ttyUSB0 115200,8,N,1 --- 230 | --- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H --- 231 | Config size: 685 232 | Wrong config version. 233 | AP password was not set in configuration 234 | State changing from: 0 to 1 235 | Setting up AP: SMLReader 236 | With default password: 237 | AP IP address: 192.168.4.1 238 | State changed from: 0 to 1 239 | ... 240 | ``` 241 | 242 | Or the dockerized way: 243 | 244 | ```bash 245 | docker run -it --device /dev/ttyUSB0 -v $(pwd):/src --rm mruettgers/esptool ash -c "miniterm.py /dev/ttyUSB0 115200" 246 | ``` 247 | 248 | 249 | 250 | ##### PlatformIO 251 | 252 | ![PlatformIO Monitor](doc/screenshots/screenshot_platformio_upload_and_monitor.png) 253 | 254 | 255 | 256 | --- 257 | 258 | ## Acknowledgements 259 | 260 | ### Third party libraries 261 | * [ESPSoftwareSerial](https://github.com/plerup/espsoftwareserial) 262 | * [IotWebConf](https://github.com/prampec/IotWebConf) 263 | * [MicroDebug](https://github.com/rlogiacco/MicroDebug) 264 | * [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) 265 | * [Pangolin MQTT Client](https://github.com/philbowles/PangolinMQTT) 266 | * [libSML](https://github.com/volkszaehler/libsml) 267 | * [JLed](https://github.com/jandelgado/jled) 268 | 269 | ### Links 270 | 271 | * https://www.msxfaq.de/sonst/bastelbude/smartmeter_d0_sml_protokoll.htm 272 | * https://www.photovoltaikforum.com/thread/78798-sml-pr%C3%BCfsummenberechnung-ich-verzweifle-an-crc/ (Helped me to finally solve some weird CRC calculation issues before switching over to libSML) 273 | * http://www.stefan-weigert.de/php_loader/sml.php (Sources of the 3D-printed housing of the reading head) 274 | * https://github.com/gemu2015/Sonoff-Tasmota (Gemu's excellent Tasmota version with SML support) 275 | 276 | ## Donate 277 | 278 | ### Paypal 279 | [![Paypal](https://www.paypalobjects.com/en_US/DK/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=GK95YZCEGJT84) 280 | 281 | ## Roadmap 282 | 283 | * [ ] Use LITTLEFS for config storage 284 | * [ ] New configuration GUI based on Preact 285 | * [ ] Configuration of sensors via web interface 286 | * [ ] Add list of devices that are known to work 287 | * [ ] Support for ASCII based SML messages (also known as "SML in Textform") 288 | * [ ] Deep sleep for battery powered devices 289 | * [ ] Grafana / InfluxDB tutorial based on docker 290 | * [ ] KNX support for sending readings via an IP gateway to the bus 291 | 292 | ## License 293 | 294 | Distributed under the GPL v3 license. 295 | See [LICENSE](LICENSE) for more information. 296 | -------------------------------------------------------------------------------- /doc/assets/SMLReader_Img_D1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/assets/SMLReader_Img_D1.jpg -------------------------------------------------------------------------------- /doc/assets/SMLReader_Img_ReadingHead.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/assets/SMLReader_Img_ReadingHead.jpg -------------------------------------------------------------------------------- /doc/assets/SMLReader_Img_ReadingHead_Close.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/assets/SMLReader_Img_ReadingHead_Close.jpg -------------------------------------------------------------------------------- /doc/assets/SMLReader_Schema.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/assets/SMLReader_Schema.png -------------------------------------------------------------------------------- /doc/samples/influxdb_grafana/.env: -------------------------------------------------------------------------------- 1 | INFLUXDB_ADMIN_USERNAME=admin 2 | INFLUXDB_ADMIN_PASSWORD=admin 3 | 4 | GRAFANA_ADMIN_USERNAME=admin 5 | GRAFANA_ADMIN_PASSWORD=admin 6 | -------------------------------------------------------------------------------- /doc/samples/influxdb_grafana/docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | services: 3 | influxdb: 4 | image: influxdb:latest 5 | ports: 6 | - '8086:8086' 7 | volumes: 8 | - influxdb-storage:/var/lib/influxdb 9 | environment: 10 | - INFLUXDB_ADMIN_USER=${INFLUXDB_ADMIN_USERNAME} 11 | - INFLUXDB_ADMIN_PASSWORD=${INFLUXDB_ADMIN_PASSWORD} 12 | 13 | chronograf: 14 | image: chronograf:latest 15 | ports: 16 | - '8888:8888' 17 | volumes: 18 | - chronograf-storage:/var/lib/chronograf 19 | depends_on: 20 | - influxdb 21 | environment: 22 | - INFLUXDB_URL=http://influxdb:8086 23 | - INFLUXDB_USERNAME=${INFLUXDB_ADMIN_USERNAME} 24 | - INFLUXDB_PASSWORD=${INFLUXDB_ADMIN_PASSWORD} 25 | 26 | telegraf: 27 | image: telegraf:latest 28 | links: 29 | - influxdb 30 | volumes: 31 | - ./telegraf/telegraf.conf:/etc/telegraf/telegraf.conf:ro 32 | 33 | grafana: 34 | image: grafana/grafana:latest 35 | ports: 36 | - '3000:3000' 37 | volumes: 38 | - grafana-storage:/var/lib/grafana 39 | depends_on: 40 | - influxdb 41 | environment: 42 | - GF_SECURITY_ADMIN_USER=${GRAFANA_ADMIN_USERNAME} 43 | - GF_SECURITY_ADMIN_PASSWORD=${GRAFANA_ADMIN_PASSWORD} 44 | 45 | volumes: 46 | influxdb-storage: 47 | chronograf-storage: 48 | grafana-storage: 49 | -------------------------------------------------------------------------------- /doc/samples/influxdb_grafana/telegraf/telegraf.conf: -------------------------------------------------------------------------------- 1 | [[outputs.influxdb]] 2 | urls = ["http://influxdb:8086"] 3 | 4 | [[inputs.mqtt_consumer]] 5 | servers = ["tcp://10.4.32.103:1883"] 6 | 7 | topics = [ 8 | "smartmeter/mains/sensor/1/obis/1-0:1.8.2*255/value", 9 | "smartmeter/mains/sensor/1/obis/1-0:16.7.0*255/value", 10 | ] 11 | 12 | data_format = "value" 13 | data_type = "float" 14 | 15 | -------------------------------------------------------------------------------- /doc/screenshots/screenshot_grafana.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/screenshots/screenshot_grafana.png -------------------------------------------------------------------------------- /doc/screenshots/screenshot_mqtt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/screenshots/screenshot_mqtt.png -------------------------------------------------------------------------------- /doc/screenshots/screenshot_platformio_build.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/screenshots/screenshot_platformio_build.png -------------------------------------------------------------------------------- /doc/screenshots/screenshot_platformio_upload.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/screenshots/screenshot_platformio_upload.png -------------------------------------------------------------------------------- /doc/screenshots/screenshot_platformio_upload_and_monitor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/screenshots/screenshot_platformio_upload_and_monitor.png -------------------------------------------------------------------------------- /doc/screenshots/screenshot_setup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/screenshots/screenshot_setup.png -------------------------------------------------------------------------------- /doc/src/SMLReader.fzz: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mruettgers/SMLReader/baa344f9d5e39625bcd01ccc161685d4b8d42507/doc/src/SMLReader.fzz -------------------------------------------------------------------------------- /include/README: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for project header files. 3 | 4 | A header file is a file containing C declarations and macro definitions 5 | to be shared between several project source files. You request the use of a 6 | header file in your project source file (C, C++, etc) located in `src` folder 7 | by including it, with the C preprocessing directive `#include'. 8 | 9 | ```src/main.c 10 | 11 | #include "header.h" 12 | 13 | int main (void) 14 | { 15 | ... 16 | } 17 | ``` 18 | 19 | Including a header file produces the same results as copying the header file 20 | into each source file that needs it. Such copying would be time-consuming 21 | and error-prone. With a header file, the related declarations appear 22 | in only one place. If they need to be changed, they can be changed in one 23 | place, and programs that include the header file will automatically use the 24 | new version when next recompiled. The header file eliminates the labor of 25 | finding and changing all the copies as well as the risk that a failure to 26 | find one copy will result in inconsistencies within a program. 27 | 28 | In C, the usual convention is to give header files names that end with `.h'. 29 | It is most portable to use only letters, digits, dashes, and underscores in 30 | header file names, and at most one dot. 31 | 32 | Read more about using header files in official GCC documentation: 33 | 34 | * Include Syntax 35 | * Include Operation 36 | * Once-Only Headers 37 | * Computed Includes 38 | 39 | https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html 40 | -------------------------------------------------------------------------------- /lib/README: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for project specific (private) libraries. 3 | PlatformIO will compile them to static libraries and link into executable file. 4 | 5 | The source code of each library should be placed in a an own separate directory 6 | ("lib/your_library_name/[here are source files]"). 7 | 8 | For example, see a structure of the following two libraries `Foo` and `Bar`: 9 | 10 | |--lib 11 | | | 12 | | |--Bar 13 | | | |--docs 14 | | | |--examples 15 | | | |--src 16 | | | |- Bar.c 17 | | | |- Bar.h 18 | | | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html 19 | | | 20 | | |--Foo 21 | | | |- Foo.c 22 | | | |- Foo.h 23 | | | 24 | | |- README --> THIS FILE 25 | | 26 | |- platformio.ini 27 | |--src 28 | |- main.c 29 | 30 | and a contents of `src/main.c`: 31 | ``` 32 | #include 33 | #include 34 | 35 | int main (void) 36 | { 37 | ... 38 | } 39 | 40 | ``` 41 | 42 | PlatformIO Library Dependency Finder will find automatically dependent 43 | libraries scanning project source files. 44 | 45 | More information about PlatformIO Library Dependency Finder 46 | - https://docs.platformio.org/page/librarymanager/ldf.html 47 | -------------------------------------------------------------------------------- /platformio.ini: -------------------------------------------------------------------------------- 1 | ; PlatformIO Project Configuration File 2 | ; 3 | ; Build options: build flags, source filter 4 | ; Upload options: custom upload port, speed and extra flags 5 | ; Library options: dependencies, extra library storages 6 | ; Advanced options: extra scripting 7 | ; 8 | ; Please visit documentation for the other options and examples 9 | ; https://docs.platformio.org/page/projectconf.html 10 | 11 | [common] 12 | platform = espressif8266@^2.4.2 13 | lib_deps = 14 | git+https://github.com/volkszaehler/libsml 15 | EspSoftwareSerial 16 | MicroDebug 17 | IotWebConf@3.2.0 18 | ESP AsyncTCP 19 | AsyncMqttClient 20 | jled 21 | 22 | env_default = d1_mini 23 | build_flags = -DIOTWEBCONF_PASSWORD_LEN=65 24 | lib_ldf_mode = deep+ 25 | 26 | [env:d1_mini] 27 | platform = ${common.platform} 28 | board = d1_mini 29 | framework = arduino 30 | lib_deps = ${common.lib_deps} 31 | lib_ldf_mode = ${common.lib_ldf_mode} 32 | build_flags = ${common.build_flags} -DSERIAL_DEBUG=false 33 | monitor_speed = 115200 34 | 35 | [env:d1_mini_debug] 36 | platform = ${common.platform} 37 | board = d1_mini 38 | framework = arduino 39 | lib_deps = ${common.lib_deps} 40 | lib_ldf_mode = ${common.lib_ldf_mode} 41 | build_flags = ${common.build_flags} -DSERIAL_DEBUG=true -DSERIAL_DEBUG_VERBOSE=false 42 | monitor_speed = 115200 43 | 44 | [env:d1_mini_dev] 45 | platform = ${common.platform} 46 | board = d1_mini 47 | framework = arduino 48 | lib_deps = ${common.lib_deps} 49 | lib_ldf_mode = ${common.lib_ldf_mode} 50 | build_flags = ${common.build_flags} -DSERIAL_DEBUG=true -DSERIAL_DEBUG_VERBOSE=false 51 | upload_port = /dev/ttyUSB0 52 | monitor_port = /dev/ttyUSB0 53 | monitor_speed = 115200 54 | -------------------------------------------------------------------------------- /src/MqttPublisher.h: -------------------------------------------------------------------------------- 1 | #ifndef MQTT_PUBLISHER_H 2 | #define MQTT_PUBLISHER_H 3 | 4 | #include "config.h" 5 | #include "debug.h" 6 | #include 7 | 8 | #include 9 | #include 10 | #include 11 | 12 | #define MQTT_RECONNECT_DELAY 5 13 | #define MQTT_LWT_TOPIC "LWT" 14 | #define MQTT_LWT_RETAIN true 15 | #define MQTT_LWT_QOS 2 16 | #define MQTT_LWT_PAYLOAD_ONLINE "Online" 17 | #define MQTT_LWT_PAYLOAD_OFFLINE "Offline" 18 | 19 | using namespace std; 20 | 21 | struct MqttConfig 22 | { 23 | char server[128] = "mosquitto"; 24 | char port[8] = "1883"; 25 | char username[128] = ""; 26 | char password[128] = ""; 27 | char topic[128] = "iot/smartmeter/"; 28 | }; 29 | 30 | class MqttPublisher 31 | { 32 | public: 33 | void setup(MqttConfig _config) 34 | { 35 | config = _config; 36 | uint8_t lastCharOfTopic = strlen(config.topic) - 1; 37 | baseTopic = String(config.topic) + (lastCharOfTopic >= 0 && config.topic[lastCharOfTopic] == '/' ? "" : "/"); 38 | lastWillTopic = String(baseTopic + MQTT_LWT_TOPIC); 39 | 40 | DEBUG(F("MQTT: Setting up...")); 41 | DEBUG(F("MQTT: Server: %s"),config.server); 42 | DEBUG(F("MQTT: Port: %d"),atoi(config.port)); 43 | DEBUG(F("MQTT: Username: %s"),config.username); 44 | DEBUG(F("MQTT: Password: ")); 45 | DEBUG(F("MQTT: Topic: %s"), baseTopic.c_str()); 46 | 47 | client.setServer(const_cast(config.server), atoi(config.port)); 48 | if (strlen(config.username) > 0 || strlen(config.password) > 0) 49 | { 50 | client.setCredentials(config.username, config.password); 51 | } 52 | client.setCleanSession(true); 53 | client.setWill(lastWillTopic.c_str(), MQTT_LWT_QOS, MQTT_LWT_RETAIN, MQTT_LWT_PAYLOAD_OFFLINE); 54 | client.setKeepAlive(MQTT_RECONNECT_DELAY * 3); 55 | this->registerHandlers(); 56 | 57 | } 58 | 59 | void debug(const char *message) 60 | { 61 | publish(baseTopic + "debug", message); 62 | } 63 | 64 | void info(const char *message) 65 | { 66 | publish(baseTopic + "info", message); 67 | } 68 | 69 | void publish(Sensor *sensor, sml_file *file) 70 | { 71 | 72 | for (int i = 0; i < file->messages_len; i++) 73 | { 74 | sml_message *message = file->messages[i]; 75 | if (*message->message_body->tag == SML_MESSAGE_GET_LIST_RESPONSE) 76 | { 77 | sml_list *entry; 78 | sml_get_list_response *body; 79 | body = (sml_get_list_response *)message->message_body->data; 80 | for (entry = body->val_list; entry != NULL; entry = entry->next) 81 | { 82 | if (!entry->value) 83 | { // do not crash on null value 84 | continue; 85 | } 86 | 87 | char obisIdentifier[32]; 88 | char buffer[255]; 89 | 90 | sprintf(obisIdentifier, "%d-%d:%d.%d.%d/%d", 91 | entry->obj_name->str[0], entry->obj_name->str[1], 92 | entry->obj_name->str[2], entry->obj_name->str[3], 93 | entry->obj_name->str[4], entry->obj_name->str[5]); 94 | 95 | String entryTopic = baseTopic + "sensor/" + (sensor->config->name) + "/obis/" + obisIdentifier + "/"; 96 | 97 | if (((entry->value->type & SML_TYPE_FIELD) == SML_TYPE_INTEGER) || 98 | ((entry->value->type & SML_TYPE_FIELD) == SML_TYPE_UNSIGNED)) 99 | { 100 | double value = sml_value_to_double(entry->value); 101 | int scaler = (entry->scaler) ? *entry->scaler : 0; 102 | int prec = -scaler; 103 | if (prec < 0) 104 | prec = 0; 105 | value = value * pow(10, scaler); 106 | sprintf(buffer, "%.*f", prec, value); 107 | publish(entryTopic + "value", buffer); 108 | } 109 | else if (!sensor->config->numeric_only) 110 | { 111 | if (entry->value->type == SML_TYPE_OCTET_STRING) 112 | { 113 | char *value; 114 | sml_value_to_strhex(entry->value, &value, true); 115 | publish(entryTopic + "value", value); 116 | free(value); 117 | } 118 | else if (entry->value->type == SML_TYPE_BOOLEAN) 119 | { 120 | publish(entryTopic + "value", entry->value->data.boolean ? "true" : "false"); 121 | } 122 | } 123 | } 124 | } 125 | } 126 | } 127 | 128 | void connect() 129 | { 130 | if (this->connected) 131 | { 132 | DEBUG(F("MQTT: Already connected. Aborting connection request.")); 133 | return; 134 | } 135 | DEBUG(F("MQTT: Connecting to broker...")); 136 | client.connect(); 137 | } 138 | 139 | void disconnect() 140 | { 141 | if (!this->connected) 142 | { 143 | DEBUG(F("MQTT: Not connected. Aborting disconnect request.")); 144 | return; 145 | } 146 | DEBUG(F("MQTT: Disconnecting from broker...")); 147 | client.disconnect(); 148 | this->reconnectTimer.detach(); 149 | } 150 | 151 | private: 152 | bool connected = false; 153 | MqttConfig config; 154 | AsyncMqttClient client; 155 | Ticker reconnectTimer; 156 | String baseTopic; 157 | String lastWillTopic; 158 | 159 | void publish(const String &topic, const String &payload, uint8_t qos=0, bool retain=false) 160 | { 161 | publish(topic.c_str(), payload.c_str(), qos, retain); 162 | } 163 | void publish(String &topic, const char *payload, uint8_t qos=0, bool retain=false) 164 | { 165 | publish(topic.c_str(), payload, qos, retain); 166 | } 167 | void publish(const char *topic, const String &payload, uint8_t qos=0, bool retain=false) 168 | { 169 | publish(topic, payload.c_str(), qos, retain); 170 | } 171 | 172 | 173 | void publish(const char *topic, const char *payload, uint8_t qos=0, bool retain=false) 174 | { 175 | if (this->connected) 176 | { 177 | DEBUG(F("MQTT: Publishing to %s:"), topic); 178 | DEBUG(F("%s\n"), payload); 179 | client.publish(topic, qos, retain, payload, strlen(payload)); 180 | } 181 | } 182 | 183 | void registerHandlers() 184 | { 185 | 186 | client.onConnect([this](bool sessionPresent) { 187 | this->connected = true; 188 | this->reconnectTimer.detach(); 189 | DEBUG(F("MQTT: Connection established.")); 190 | char message[64]; 191 | snprintf(message, 64, "Hello from %08X, running SMLReader version %s.", ESP.getChipId(), VERSION); 192 | info(message); 193 | publish(baseTopic + MQTT_LWT_TOPIC, MQTT_LWT_PAYLOAD_ONLINE, MQTT_LWT_QOS, MQTT_LWT_RETAIN); 194 | }); 195 | client.onDisconnect([this](AsyncMqttClientDisconnectReason reason) { 196 | this->connected = false; 197 | DEBUG(F("MQTT: Disconnected. Reason: %d."), reason); 198 | reconnectTimer.attach(MQTT_RECONNECT_DELAY, [this]() { 199 | if (WiFi.isConnected()) { 200 | this->connect(); 201 | } 202 | }); 203 | }); 204 | } 205 | }; 206 | 207 | #endif -------------------------------------------------------------------------------- /src/Sensor.h: -------------------------------------------------------------------------------- 1 | #ifndef SENSOR_H 2 | #define SENSOR_H 3 | 4 | #include 5 | #include 6 | #include "debug.h" 7 | 8 | using namespace std; 9 | 10 | // SML constants 11 | const byte START_SEQUENCE[] = {0x1B, 0x1B, 0x1B, 0x1B, 0x01, 0x01, 0x01, 0x01}; 12 | const byte END_SEQUENCE[] = {0x1B, 0x1B, 0x1B, 0x1B, 0x1A}; 13 | const size_t BUFFER_SIZE = 3840; // Max datagram duration 400ms at 9600 Baud 14 | const uint8_t READ_TIMEOUT = 30; 15 | 16 | // States 17 | enum State 18 | { 19 | INIT, 20 | STANDBY, 21 | WAIT_FOR_START_SEQUENCE, 22 | READ_MESSAGE, 23 | PROCESS_MESSAGE, 24 | READ_CHECKSUM 25 | }; 26 | 27 | uint64_t millis64() 28 | { 29 | static uint32_t low32, high32; 30 | uint32_t new_low32 = millis(); 31 | if (new_low32 < low32) 32 | high32++; 33 | low32 = new_low32; 34 | return (uint64_t)high32 << 32 | low32; 35 | } 36 | 37 | class SensorConfig 38 | { 39 | public: 40 | const uint8_t pin; 41 | const char *name; 42 | const bool numeric_only; 43 | const bool status_led_enabled; 44 | const bool status_led_inverted; 45 | const uint8_t status_led_pin; 46 | const uint8_t interval; 47 | }; 48 | 49 | class Sensor 50 | { 51 | public: 52 | const SensorConfig *config; 53 | Sensor(const SensorConfig *config, void (*callback)(byte *buffer, size_t len, Sensor *sensor)) 54 | { 55 | this->config = config; 56 | DEBUG("Initializing sensor %s...", this->config->name); 57 | this->callback = callback; 58 | this->serial = unique_ptr(new SoftwareSerial()); 59 | this->serial->begin(9600, SWSERIAL_8N1, this->config->pin, -1, false); 60 | this->serial->enableTx(false); 61 | this->serial->enableRx(true); 62 | DEBUG("Initialized sensor %s.", this->config->name); 63 | 64 | if (this->config->status_led_enabled) 65 | { 66 | this->status_led = unique_ptr(new JLed(this->config->status_led_pin)); 67 | if (this->config->status_led_inverted) 68 | { 69 | this->status_led->LowActive(); 70 | } 71 | } 72 | 73 | this->init_state(); 74 | } 75 | 76 | void loop() 77 | { 78 | this->run_current_state(); 79 | yield(); 80 | if (this->config->status_led_enabled) 81 | { 82 | this->status_led->Update(); 83 | yield(); 84 | } 85 | } 86 | 87 | private: 88 | unique_ptr serial; 89 | byte buffer[BUFFER_SIZE]; 90 | size_t position = 0; 91 | unsigned long last_state_reset = 0; 92 | uint64_t standby_until = 0; 93 | uint8_t bytes_until_checksum = 0; 94 | uint8_t loop_counter = 0; 95 | State state = INIT; 96 | void (*callback)(byte *buffer, size_t len, Sensor *sensor) = NULL; 97 | unique_ptr status_led; 98 | 99 | void run_current_state() 100 | { 101 | if (this->state != INIT) 102 | { 103 | if (this->state != STANDBY && ((millis() - this->last_state_reset) > (READ_TIMEOUT * 1000))) 104 | { 105 | DEBUG("Did not receive an SML message within %d seconds, starting over.", READ_TIMEOUT); 106 | this->reset_state(); 107 | } 108 | switch (this->state) 109 | { 110 | case STANDBY: 111 | this->standby(); 112 | break; 113 | case WAIT_FOR_START_SEQUENCE: 114 | this->wait_for_start_sequence(); 115 | break; 116 | case READ_MESSAGE: 117 | this->read_message(); 118 | break; 119 | case PROCESS_MESSAGE: 120 | this->process_message(); 121 | break; 122 | case READ_CHECKSUM: 123 | this->read_checksum(); 124 | break; 125 | default: 126 | break; 127 | } 128 | } 129 | } 130 | 131 | // Wrappers for sensor access 132 | int data_available() 133 | { 134 | return this->serial->available(); 135 | } 136 | int data_read() 137 | { 138 | return this->serial->read(); 139 | } 140 | 141 | // Set state 142 | void set_state(State new_state) 143 | { 144 | if (new_state == STANDBY) 145 | { 146 | DEBUG("State of sensor %s is 'STANDBY'.", this->config->name); 147 | } 148 | else if (new_state == WAIT_FOR_START_SEQUENCE) 149 | { 150 | DEBUG("State of sensor %s is 'WAIT_FOR_START_SEQUENCE'.", this->config->name); 151 | this->last_state_reset = millis(); 152 | this->position = 0; 153 | } 154 | else if (new_state == READ_MESSAGE) 155 | { 156 | DEBUG("State of sensor %s is 'READ_MESSAGE'.", this->config->name); 157 | } 158 | else if (new_state == READ_CHECKSUM) 159 | { 160 | DEBUG("State of sensor %s is 'READ_CHECKSUM'.", this->config->name); 161 | this->bytes_until_checksum = 3; 162 | } 163 | else if (new_state == PROCESS_MESSAGE) 164 | { 165 | DEBUG("State of sensor %s is 'PROCESS_MESSAGE'.", this->config->name); 166 | }; 167 | this->state = new_state; 168 | } 169 | 170 | // Initialize state machine 171 | void init_state() 172 | { 173 | this->set_state(WAIT_FOR_START_SEQUENCE); 174 | } 175 | 176 | // Start over and wait for the start sequence 177 | void reset_state(const char *message = NULL) 178 | { 179 | if (message != NULL && strlen(message) > 0) 180 | { 181 | DEBUG(message); 182 | } 183 | this->init_state(); 184 | } 185 | 186 | void standby() 187 | { 188 | // Keep buffers clean 189 | while (this->data_available()) 190 | { 191 | this->data_read(); 192 | yield(); 193 | } 194 | 195 | if (millis64() >= this->standby_until) 196 | { 197 | this->reset_state(); 198 | } 199 | } 200 | 201 | // Wait for the start_sequence to appear 202 | void wait_for_start_sequence() 203 | { 204 | while (this->data_available()) 205 | { 206 | this->buffer[this->position] = this->data_read(); 207 | yield(); 208 | 209 | this->position = (this->buffer[this->position] == START_SEQUENCE[this->position]) ? (this->position + 1) : 0; 210 | if (this->position == sizeof(START_SEQUENCE)) 211 | { 212 | // Start sequence has been found 213 | DEBUG("Start sequence found."); 214 | if (this->config->status_led_enabled) 215 | { 216 | this->status_led->Blink(50, 50).Repeat(3); 217 | } 218 | this->set_state(READ_MESSAGE); 219 | return; 220 | } 221 | } 222 | } 223 | 224 | // Read the rest of the message 225 | void read_message() 226 | { 227 | while (this->data_available()) 228 | { 229 | // Check whether the buffer is still big enough to hold the number of fill bytes (1 byte) and the checksum (2 bytes) 230 | if ((this->position + 3) == BUFFER_SIZE) 231 | { 232 | this->reset_state("Buffer will overflow, starting over."); 233 | return; 234 | } 235 | this->buffer[this->position++] = this->data_read(); 236 | yield(); 237 | 238 | // Check for end sequence 239 | int last_index_of_end_seq = sizeof(END_SEQUENCE) - 1; 240 | for (int i = 0; i <= last_index_of_end_seq; i++) 241 | { 242 | if (END_SEQUENCE[last_index_of_end_seq - i] != this->buffer[this->position - (i + 1)]) 243 | { 244 | break; 245 | } 246 | if (i == last_index_of_end_seq) 247 | { 248 | DEBUG("End sequence found."); 249 | this->set_state(READ_CHECKSUM); 250 | return; 251 | } 252 | } 253 | } 254 | } 255 | 256 | // Read the number of fillbytes and the checksum 257 | void read_checksum() 258 | { 259 | while (this->bytes_until_checksum > 0 && this->data_available()) 260 | { 261 | this->buffer[this->position++] = this->data_read(); 262 | this->bytes_until_checksum--; 263 | yield(); 264 | } 265 | 266 | if (this->bytes_until_checksum == 0) 267 | { 268 | DEBUG("Message has been read."); 269 | DEBUG_DUMP_BUFFER(this->buffer, this->position); 270 | this->set_state(PROCESS_MESSAGE); 271 | } 272 | } 273 | 274 | void process_message() 275 | { 276 | DEBUG("Message is being processed."); 277 | 278 | if (this->config->interval > 0) 279 | { 280 | this->standby_until = millis64() + (this->config->interval * 1000); 281 | } 282 | 283 | // Call listener 284 | if (this->callback != NULL) 285 | { 286 | this->callback(this->buffer, this->position, this); 287 | } 288 | 289 | // Go to standby mode, if throttling is enabled 290 | if (this->config->interval > 0) 291 | { 292 | this->set_state(STANDBY); 293 | return; 294 | } 295 | 296 | // Start over if throttling is disabled 297 | this->reset_state(); 298 | } 299 | }; 300 | 301 | #endif -------------------------------------------------------------------------------- /src/config.h: -------------------------------------------------------------------------------- 1 | #ifndef CONFIG_H 2 | #define CONFIG_H 3 | 4 | #include "Arduino.h" 5 | #include "Sensor.h" 6 | 7 | const char *VERSION = "2.3.0"; 8 | 9 | // Modifying the config version will probably cause a loss of the existig configuration. 10 | // Be careful! 11 | const char *CONFIG_VERSION = "1.0.2"; 12 | 13 | const char *WIFI_AP_SSID = "SMLReader"; 14 | const char *WIFI_AP_DEFAULT_PASSWORD = ""; 15 | 16 | static const SensorConfig SENSOR_CONFIGS[] = { 17 | {.pin = D2, 18 | .name = "1", 19 | .numeric_only = false, 20 | .status_led_enabled = true, 21 | .status_led_inverted = true, 22 | .status_led_pin = LED_BUILTIN, 23 | .interval = 0}}; 24 | 25 | const uint8_t NUM_OF_SENSORS = sizeof(SENSOR_CONFIGS) / sizeof(SensorConfig); 26 | 27 | #endif -------------------------------------------------------------------------------- /src/debug.h: -------------------------------------------------------------------------------- 1 | #ifndef DEBUG_H 2 | #define DEBUG_H 3 | 4 | #include "FormattingSerialDebug.h" 5 | #include 6 | #include 7 | #include "unit.h" 8 | 9 | #ifdef DEBUG 10 | #define SERIAL_DEBUG true 11 | #else 12 | #define SERIAL_DEBUG false 13 | #endif 14 | 15 | void DEBUG_DUMP_BUFFER(byte *buf, int size) 16 | { 17 | #if (defined(SERIAL_DEBUG_VERBOSE) && SERIAL_DEBUG_VERBOSE) 18 | DEBUG("----DATA----"); 19 | for (int i = 0; i < size; i++) 20 | { 21 | if (buf[i] < 16) 22 | { 23 | SERIAL_DEBUG_IMPL.print("0"); 24 | } 25 | SERIAL_DEBUG_IMPL.print(buf[i], HEX); 26 | SERIAL_DEBUG_IMPL.print(" "); 27 | if (((i + 1) % 16) == 0) 28 | { 29 | SERIAL_DEBUG_IMPL.println(); 30 | } 31 | } 32 | SERIAL_DEBUG_IMPL.println(); 33 | DEBUG("---END OF DATA---"); 34 | #endif 35 | } 36 | 37 | void DEBUG_SML_FILE(sml_file *file) 38 | { 39 | #if (defined(SERIAL_DEBUG) && SERIAL_DEBUG) 40 | 41 | sml_file_print(file); 42 | 43 | // read here some values ... 44 | printf("OBIS data\n"); 45 | for (int i = 0; i < file->messages_len; i++) 46 | { 47 | sml_message *message = file->messages[i]; 48 | if (*message->message_body->tag == SML_MESSAGE_GET_LIST_RESPONSE) 49 | { 50 | sml_list *entry; 51 | sml_get_list_response *body; 52 | body = (sml_get_list_response *)message->message_body->data; 53 | for (entry = body->val_list; entry != NULL; entry = entry->next) 54 | { 55 | if (!entry->value) 56 | { // do not crash on null value 57 | fprintf(stderr, "Error in data stream. entry->value should not be NULL. Skipping this.\n"); 58 | continue; 59 | } 60 | if (entry->value->type == SML_TYPE_OCTET_STRING) 61 | { 62 | char *str; 63 | printf("%d-%d:%d.%d.%d*%d#%s#\n", 64 | entry->obj_name->str[0], entry->obj_name->str[1], 65 | entry->obj_name->str[2], entry->obj_name->str[3], 66 | entry->obj_name->str[4], entry->obj_name->str[5], 67 | sml_value_to_strhex(entry->value, &str, true)); 68 | free(str); 69 | } 70 | else if (entry->value->type == SML_TYPE_BOOLEAN) 71 | { 72 | printf("%d-%d:%d.%d.%d*%d#%s#\n", 73 | entry->obj_name->str[0], entry->obj_name->str[1], 74 | entry->obj_name->str[2], entry->obj_name->str[3], 75 | entry->obj_name->str[4], entry->obj_name->str[5], 76 | entry->value->data.boolean ? "true" : "false"); 77 | } 78 | else if (((entry->value->type & SML_TYPE_FIELD) == SML_TYPE_INTEGER) || 79 | ((entry->value->type & SML_TYPE_FIELD) == SML_TYPE_UNSIGNED)) 80 | { 81 | double value = sml_value_to_double(entry->value); 82 | int scaler = (entry->scaler) ? *entry->scaler : 0; 83 | int prec = -scaler; 84 | if (prec < 0) 85 | prec = 0; 86 | value = value * pow(10, scaler); 87 | printf("%d-%d:%d.%d.%d*%d#%.*f#", 88 | entry->obj_name->str[0], entry->obj_name->str[1], 89 | entry->obj_name->str[2], entry->obj_name->str[3], 90 | entry->obj_name->str[4], entry->obj_name->str[5], prec, value); 91 | const char *unit = NULL; 92 | if (entry->unit && // do not crash on null (unit is optional) 93 | (unit = dlms_get_unit((unsigned char)*entry->unit)) != NULL) 94 | printf("%s", unit); 95 | printf("\n"); 96 | // flush the stdout puffer, that pipes work without waiting 97 | fflush(stdout); 98 | } 99 | } 100 | } 101 | } 102 | #endif 103 | } 104 | 105 | #endif 106 | -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "config.h" 3 | #include "debug.h" 4 | #include 5 | #include "Sensor.h" 6 | #include 7 | #include "MqttPublisher.h" 8 | #include "EEPROM.h" 9 | #include 10 | #include 11 | #include 12 | 13 | std::list *sensors = new std::list(); 14 | 15 | void wifiConnected(); 16 | void configSaved(); 17 | 18 | DNSServer dnsServer; 19 | WebServer server(80); 20 | ESP8266HTTPUpdateServer httpUpdater; 21 | WiFiClient net; 22 | 23 | MqttConfig mqttConfig; 24 | MqttPublisher publisher; 25 | 26 | IotWebConf iotWebConf(WIFI_AP_SSID, &dnsServer, &server, WIFI_AP_DEFAULT_PASSWORD, CONFIG_VERSION); 27 | 28 | iotwebconf::TextParameter mqttServerParam = iotwebconf::TextParameter("MQTT server", "mqttServer", mqttConfig.server, sizeof(mqttConfig.server), nullptr, mqttConfig.server); 29 | iotwebconf::NumberParameter mqttPortParam = iotwebconf::NumberParameter("MQTT port", "mqttPort", mqttConfig.port, sizeof(mqttConfig.port), nullptr, mqttConfig.port); 30 | iotwebconf::TextParameter mqttUsernameParam = iotwebconf::TextParameter("MQTT username", "mqttUsername", mqttConfig.username, sizeof(mqttConfig.username), nullptr, mqttConfig.username); 31 | iotwebconf::PasswordParameter mqttPasswordParam = iotwebconf::PasswordParameter("MQTT password", "mqttPassword", mqttConfig.password, sizeof(mqttConfig.password), nullptr, mqttConfig.password); 32 | iotwebconf::TextParameter mqttTopicParam = iotwebconf::TextParameter("MQTT topic", "mqttTopic", mqttConfig.topic, sizeof(mqttConfig.topic), nullptr, mqttConfig.topic); 33 | iotwebconf::ParameterGroup paramGroup = iotwebconf::ParameterGroup("MQTT Settings", ""); 34 | 35 | boolean needReset = false; 36 | 37 | void process_message(byte *buffer, size_t len, Sensor *sensor) 38 | { 39 | // Parse 40 | sml_file *file = sml_file_parse(buffer + 8, len - 16); 41 | 42 | DEBUG_SML_FILE(file); 43 | 44 | publisher.publish(sensor, file); 45 | 46 | // free the malloc'd memory 47 | sml_file_free(file); 48 | } 49 | 50 | void setup() 51 | { 52 | // Setup debugging stuff 53 | SERIAL_DEBUG_SETUP(115200); 54 | 55 | #ifdef DEBUG 56 | // Delay for getting a serial console attached in time 57 | delay(2000); 58 | #endif 59 | 60 | // Setup reading heads 61 | DEBUG("Setting up %d configured sensors...", NUM_OF_SENSORS); 62 | const SensorConfig *config = SENSOR_CONFIGS; 63 | for (uint8_t i = 0; i < NUM_OF_SENSORS; i++, config++) 64 | { 65 | Sensor *sensor = new Sensor(config, process_message); 66 | sensors->push_back(sensor); 67 | } 68 | DEBUG("Sensor setup done."); 69 | 70 | // Initialize publisher 71 | // Setup WiFi and config stuff 72 | DEBUG("Setting up WiFi and config stuff."); 73 | 74 | paramGroup.addItem(&mqttServerParam); 75 | paramGroup.addItem(&mqttPortParam); 76 | paramGroup.addItem(&mqttUsernameParam); 77 | paramGroup.addItem(&mqttPasswordParam); 78 | paramGroup.addItem(&mqttTopicParam); 79 | 80 | iotWebConf.addParameterGroup(¶mGroup); 81 | 82 | iotWebConf.setConfigSavedCallback(&configSaved); 83 | iotWebConf.setWifiConnectionCallback(&wifiConnected); 84 | 85 | 86 | WiFi.onStationModeDisconnected([](const WiFiEventStationModeDisconnected& event) { 87 | publisher.disconnect(); 88 | }); 89 | 90 | // -- Define how to handle updateServer calls. 91 | iotWebConf.setupUpdateServer( 92 | [](const char *updatePath) 93 | { httpUpdater.setup(&server, updatePath); }, 94 | [](const char *userName, char *password) 95 | { httpUpdater.updateCredentials(userName, password); }); 96 | 97 | boolean validConfig = iotWebConf.init(); 98 | if (!validConfig) 99 | { 100 | DEBUG("Missing or invalid config. MQTT publisher disabled."); 101 | } 102 | else 103 | { 104 | // Setup MQTT publisher 105 | publisher.setup(mqttConfig); 106 | } 107 | 108 | server.on("/", []() { iotWebConf.handleConfig(); }); 109 | server.on("/reset", []() { needReset = true; }); 110 | server.onNotFound([]() { iotWebConf.handleNotFound(); }); 111 | 112 | DEBUG("Setup done."); 113 | } 114 | 115 | void loop() 116 | { 117 | if (needReset) 118 | { 119 | // Doing a chip reset caused by config changes 120 | DEBUG("Rebooting after 1 second."); 121 | delay(1000); 122 | ESP.restart(); 123 | } 124 | 125 | // Execute sensor state machines 126 | for (std::list::iterator it = sensors->begin(); it != sensors->end(); ++it){ 127 | (*it)->loop(); 128 | } 129 | iotWebConf.doLoop(); 130 | yield(); 131 | } 132 | 133 | void configSaved() 134 | { 135 | DEBUG("Configuration was updated."); 136 | needReset = true; 137 | } 138 | 139 | void wifiConnected() 140 | { 141 | DEBUG("WiFi connection established."); 142 | publisher.connect(); 143 | } -------------------------------------------------------------------------------- /src/unit.h: -------------------------------------------------------------------------------- 1 | /** 2 | * DLMS Units as specified in ISO EN 62056-62 and used by SML 3 | * 4 | * @package libsml 5 | * @copyright Copyright (c) 2011, The volkszaehler.org project 6 | * @license http://www.gnu.org/licenses/gpl.txt GNU Public License 7 | * @author Steffen Vogel 8 | */ 9 | /* 10 | * This file is part of volkzaehler.org 11 | * 12 | * volkzaehler.org is free software: you can redistribute it and/or modify 13 | * it under the terms of the GNU General Public License as published by 14 | * the Free Software Foundation, either version 3 of the License, or 15 | * any later version. 16 | * 17 | * volkzaehler.org is distributed in the hope that it will be useful, 18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | * GNU General Public License for more details. 21 | * 22 | * You should have received a copy of the GNU General Public License 23 | * along with volkszaehler.org. If not, see . 24 | */ 25 | 26 | typedef struct { 27 | unsigned char code; 28 | const char *unit; 29 | } dlms_unit_t; 30 | 31 | /** 32 | * Static lookup table 33 | */ 34 | dlms_unit_t dlms_units[] = { 35 | // code, unit // Quantity Unit name SI definition (comment) 36 | //===================================================================================================== 37 | {1, "a"}, // time year 52*7*24*60*60 s 38 | {2, "mo"}, // time month 31*24*60*60 s 39 | {3, "wk"}, // time week 7*24*60*60 s 40 | {4, "d"}, // time day 24*60*60 s 41 | {5, "h"}, // time hour 60*60 s 42 | {6, "min."}, // time min 60 s 43 | {7, "s"}, // time (t) second s 44 | {8, "°"}, // (phase) angle degree rad*180/π 45 | {9, "°C"}, // temperature (T) degree celsius K-273.15 46 | {10, "currency"}, // (local) currency 47 | {11, "m"}, // length (l) metre m 48 | {12, "m/s"}, // speed (v) metre per second m/s 49 | {13, "m³"}, // volume (V) cubic metre m³ 50 | {14, "m³"}, // corrected volume cubic metre m³ 51 | {15, "m³/h"}, // volume flux cubic metre per hour m³/(60*60s) 52 | {16, "m³/h"}, // corrected volume flux cubic metre per hour m³/(60*60s) 53 | {17, "m³/d"}, // volume flux m³/(24*60*60s) 54 | {18, "m³/d"}, // corrected volume flux m³/(24*60*60s) 55 | {19, "l"}, // volume litre 10-3 m³ 56 | {20, "kg"}, // mass (m) kilogram 57 | {21, "N"}, // force (F) newton 58 | {22, "Nm"}, // energy newtonmeter J = Nm = Ws 59 | {23, "Pa"}, // pressure (p) pascal N/m² 60 | {24, "bar"}, // pressure (p) bar 10⁵ N/m² 61 | {25, "J"}, // energy joule J = Nm = Ws 62 | {26, "J/h"}, // thermal power joule per hour J/(60*60s) 63 | {27, "W"}, // active power (P) watt W = J/s 64 | {28, "VA"}, // apparent power (S) volt-ampere 65 | {29, "var"}, // reactive power (Q) var 66 | {30, "Wh"}, // active energy watt-hour W*(60*60s) 67 | {31, "VAh"}, // apparent energy volt-ampere-hour VA*(60*60s) 68 | {32, "varh"}, // reactive energy var-hour var*(60*60s) 69 | {33, "A"}, // current (I) ampere A 70 | {34, "C"}, // electrical charge (Q) coulomb C = As 71 | {35, "V"}, // voltage (U) volt V 72 | {36, "V/m"}, // electr. field strength (E) volt per metre 73 | {37, "F"}, // capacitance (C) farad C/V = As/V 74 | {38, "Ω"}, // resistance (R) ohm Ω = V/A 75 | {39, "Ωm²/m"}, // resistivity (ρ) Ωm 76 | {40, "Wb"}, // magnetic flux (Φ) weber Wb = Vs 77 | {41, "T"}, // magnetic flux density (B) tesla Wb/m2 78 | {42, "A/m"}, // magnetic field strength (H) ampere per metre A/m 79 | {43, "H"}, // inductance (L) henry H = Wb/A 80 | {44, "Hz"}, // frequency (f, ω) hertz 1/s 81 | {45, "1/(Wh)"}, // R_W (Active energy meter constant or pulse value) 82 | {46, "1/(varh)"}, // R_B (reactive energy meter constant or pulse value) 83 | {47, "1/(VAh)"}, // R_S (apparent energy meter constant or pulse value) 84 | {48, "V²h"}, // volt-squared hour volt-squaredhours V²(60*60s) 85 | {49, "A²h"}, // ampere-squared hour ampere-squaredhours A²(60*60s) 86 | {50, "kg/s"}, // mass flux kilogram per second kg/s 87 | {51, "S, mho"}, // conductance siemens 1/Ω 88 | {52, "K"}, // temperature (T) kelvin 89 | {53, "1/(V²h)"}, // R_U²h (Volt-squared hour meter constant or pulse value) 90 | {54, "1/(A²h)"}, // R_I²h (Ampere-squared hour meter constant or pulse value) 91 | {55, "1/m³"}, // R_V, meter constant or pulse value (volume) 92 | {56, "%"}, // percentage % 93 | {57, "Ah"}, // ampere-hours ampere-hour 94 | {60, "Wh/m³"}, // energy per volume 3,6*103 J/m³ 95 | {61, "J/m³"}, // calorific value, wobbe 96 | {62, "Mol %"}, // molar fraction of mole percent (Basic gas composition unit) 97 | // gas composition 98 | {63, "g/m³"}, // mass density, quantity of material (Gas analysis, accompanying elements) 99 | {64, "Pa s"}, // dynamic viscosity pascal second (Characteristic of gas stream) 100 | {253, "(reserved)"}, // reserved 101 | {254, "(other)"}, // other unit 102 | {255, "(unitless)"}, // no unit, unitless, count 103 | {0, ""} // stop condition for iterator 104 | }; 105 | 106 | const char * dlms_get_unit(unsigned char code) { 107 | dlms_unit_t *it = dlms_units; 108 | do { // linear search 109 | if (it->code == code) { 110 | return it->unit; 111 | } 112 | } while ((++it)->code); 113 | 114 | return NULL; // not found 115 | } -------------------------------------------------------------------------------- /test/README: -------------------------------------------------------------------------------- 1 | 2 | This directory is intended for PIO Unit Testing and project tests. 3 | 4 | Unit Testing is a software testing method by which individual units of 5 | source code, sets of one or more MCU program modules together with associated 6 | control data, usage procedures, and operating procedures, are tested to 7 | determine whether they are fit for use. Unit testing finds problems early 8 | in the development cycle. 9 | 10 | More information about PIO Unit Testing: 11 | - https://docs.platformio.org/page/plus/unit-testing.html 12 | --------------------------------------------------------------------------------