Skip to content

Improve Readme #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PolarGoose merged 1 commit into from
Dec 2, 2025
Merged

Improve Readme #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Note: [dlms_packet_decryptor.h](https://github.com/esphome-libs/dsmr_parser/blob

## Usage from PlatformIO
The library is available on the PlatformIO registry:<br>
**TODO: configure deployment to PlatformIO **
[esphome/dsmr_parser](https://registry.platformio.org/libraries/esphome/dsmr_parser)

# Examples
* How to use the parser
Expand All @@ -36,8 +36,6 @@ The library is available on the PlatformIO registry:<br>
[matthijskooijman](https://github.com/matthijskooijman) is the original creator of this DSMR parser.
[glmnet](https://github.com/glmnet) and [zuidwijk](https://github.com/zuidwijk) continued work on this parser in the fork [glmnet/arduino-dsmr](https://github.com/glmnet/arduino-dsmr). They used the parser to create [ESPHome DSMR](https://esphome.io/components/sensor/dsmr/) component.
After that, the work on the `arduino-dsmr` parser stopped.
Since then, some issues and unmerged pull requests have accumulated. Additionally, the dependency on the Arduino framework causes various issues for some ESP32 boards.
This fork addresses the existing issues and makes the parser usable on any platform.

## The reasons `dsmr_parser` fork was created
* Dependency on the Arduino framework limits the applicability of this parser. For example, it is not possible to use it on Linux.
Expand All @@ -46,9 +44,10 @@ This fork addresses the existing issues and makes the parser usable on any platf
* Lack of support for encrypted DSMR messages.

# How to work with the code
* You can open the code using any IDE that supports CMake.
* `build-windows.ps1` script needs `Visual Studio 2022` to be installed.
* `build-linux.sh` script needs `clang` to be installed.
* You can open the code using any IDE that supports CMake. It will allow you to modify the code and run the tests.
* Notes if you want to run the build scripts:
* `build-win.ps1` needs `Visual Studio` to be installed.
* `build-linux.sh` needs `clang` to be installed.

# References
* [DSMR parser in Python](https://github.com/ndokter/dsmr_parser/tree/master) - alternative DSMR parser implementation in Python.
Expand Down
8 changes: 4 additions & 4 deletions build-win.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,14 @@ Info "Find Visual Studio installation path"
$vswhereCommand = Get-Command -Name "${Env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe"
$installationPath = & $vswhereCommand -prerelease -latest -property installationPath

Info "Open Visual Studio 2022 Developer PowerShell amd64"
& "$installationPath\Common7\Tools\Launch-VsDevShell.ps1" -Arch amd64
Info "Open Visual Studio Developer PowerShell amd64"
& "$installationPath\Common7\Tools\Launch-VsDevShell.ps1" -SkipAutomaticLocation -Arch amd64

BuildAndTest -buildType Debug -arch amd64
BuildAndTest -buildType Release -arch amd64

Info "Open Visual Studio 2022 Developer PowerShell x86"
& "$installationPath\Common7\Tools\Launch-VsDevShell.ps1" -Arch x86
Info "Open Visual Studio Developer PowerShell x86"
& "$installationPath\Common7\Tools\Launch-VsDevShell.ps1" -SkipAutomaticLocation -Arch x86

BuildAndTest -buildType Debug -arch x86
BuildAndTest -buildType Release -arch x86