Skip to content

Commit 2b3d15d

Browse files
authored
Improve Readme and build-win.ps1 script
* Add a reference to the PlatformIO package * Improve the "How to work with the code" section Improve `build-win.ps1` script: * Add `-SkipAutomaticLocation` flag to `Launch-VsDevShell.ps1` to not change the current directory.
1 parent 0f95a40 commit 2b3d15d

File tree

2 files changed

+9
-10
lines changed

2 files changed

+9
-10
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Note: [dlms_packet_decryptor.h](https://github.com/esphome-libs/dsmr_parser/blob
2121

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

2626
# Examples
2727
* How to use the parser
@@ -36,8 +36,6 @@ The library is available on the PlatformIO registry:<br>
3636
[matthijskooijman](https://github.com/matthijskooijman) is the original creator of this DSMR parser.
3737
[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.
3838
After that, the work on the `arduino-dsmr` parser stopped.
39-
Since then, some issues and unmerged pull requests have accumulated. Additionally, the dependency on the Arduino framework causes various issues for some ESP32 boards.
40-
This fork addresses the existing issues and makes the parser usable on any platform.
4139

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

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

5352
# References
5453
* [DSMR parser in Python](https://github.com/ndokter/dsmr_parser/tree/master) - alternative DSMR parser implementation in Python.

build-win.ps1

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ Info "Find Visual Studio installation path"
4646
$vswhereCommand = Get-Command -Name "${Env:ProgramFiles(x86)}\Microsoft Visual Studio\Installer\vswhere.exe"
4747
$installationPath = & $vswhereCommand -prerelease -latest -property installationPath
4848

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

5252
BuildAndTest -buildType Debug -arch amd64
5353
BuildAndTest -buildType Release -arch amd64
5454

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

5858
BuildAndTest -buildType Debug -arch x86
5959
BuildAndTest -buildType Release -arch x86

0 commit comments

Comments
 (0)