Skip to content
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.

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

feat: add DSMR-reader support with configuration files #6

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Diondk
Copy link
Contributor

@Diondk Diondk commented Dec 4, 2024

Overview

  • Added a new DSMR folder containing configuration files for Ethernet and WiFi setups.
  • These changes support integration with DSMR-Reader for enhanced monitoring and data visualization.

Files Added

  • DSMR/waterp1meterkit-dsmr-ethernet.yaml: Configuration for Ethernet-based connections.
  • DSMR/waterp1meterkit-dsmr-wifi.yaml: Configuration for WiFi-based connections.

Purpose

This PR introduces DSMR-Reader support to the Watermeter P1 Kit, expanding its functionality and usability.

feat: add DSMR-Reader support to Watermeter P1 Kit  

- Implement data formatting and communication adjustments for DSMR-Reader integration.  
- Add configuration options for DSMR-Reader connection details (e.g., host, port,api key).  


This update enables users to push Waterp1meter Kit data to DSMR-Reader, enhancing monitoring capabilities and analytics.
- Implement data formatting and communication adjustments for DSMR-Reader integration.  
- Add configuration options for DSMR-Reader connection details (e.g., host, port, api key).  


This update enables users to push Waterp1meter Kit data to DSMR-Reader, enhancing monitoring capabilities and analytics.
@Diondk Diondk changed the title feat: add DSMR support with configuration files feat: add DSMR-reader support with configuration files Dec 4, 2024
Diondk added 11 commits December 4, 2024 15:42
- Implement data formatting and communication adjustments for DSMR-Reader integration.  
- Add configuration options for DSMR-Reader connection details (e.g., host, port, api key).  
- Update documentation to guide users in setting up DSMR-Reader with the Watermeter P1 Kit.  

This update enables users to push Waterp1meter Kit data to DSMR-Reader, enhancing monitoring capabilities and analytics.
- Implement data formatting and communication adjustments for DSMR-Reader integration.  
- Add configuration options for DSMR-Reader connection details (e.g., host, port, api key).  
- Update documentation to guide users in setting up DSMR-Reader with the Watermeter P1 Kit.  

This update enables users to push Waterp1meter Kit data to DSMR-Reader, enhancing monitoring capabilities and analytics.
docs: add README.md for DSMR integration  

- Explain DSMR-Reader and its purpose.  
- Provide instructions to enable the API in DSMR-Reader.  
- Include steps to generate an API token.  
- Detail configuration updates required for DSMR integration.  
- Add troubleshooting tips for verifying the setup.
refactor: move configuration files to versioned folder structure  

- Relocate `waterp1meterkit-ethernet.yaml` and `waterp1meterkit-wifi.yaml` to a new folder named `waterp1meterkit-v1`.  
- Establish versioned folder structure to organize future versions of the software.  
- Ensure backward compatibility by preserving file names within the new folder.
refactor: move configuration files to versioned folder structure  

- Relocate `waterp1meterkit-ethernet.yaml` and `waterp1meterkit-wifi.yaml` to a new folder named `waterp1meterkit-v1`.  
- Establish versioned folder structure to organize future versions of the software.  
- Ensure backward compatibility by preserving file names within the new folder.
refactor: move configuration files to versioned folder structure  

- Relocate `waterp1meterkit-ethernet.yaml` and `waterp1meterkit-wifi.yaml` to a new folder named `waterp1meterkit-v1`.  
- Establish versioned folder structure to organize future versions of the software.  
- Ensure backward compatibility by preserving file names within the new folder.
refactor: move configuration files to versioned folder structure  

- Relocate `waterp1meterkit-ethernet.yaml` and `waterp1meterkit-wifi.yaml` to a new folder named `waterp1meterkit-v1`.  
- Establish versioned folder structure to organize future versions of the software.  
- Ensure backward compatibility by preserving file names within the new folder.
docs: add version-specific warning to README.md  

- Added a warning to indicate compatibility with v1.1 of the WaterP1MeterKit.  
- Clarified that files and configurations are intended for v1.1 firmware only.  
- Highlighted potential issues with other versions to prevent compatibility confusion.
@Diondk
Copy link
Contributor Author

Diondk commented Dec 4, 2024

docs: update README.md, adjust image path, and document new folder structure

  • Added version-specific warning for v1.1 of the WaterP1MeterKit in the README.md.
  • Clarified that configurations and files are only compatible with v1.1 firmware.
  • Updated the image path in README.md to reflect the correct location for the logo.
  • Documented the new folder structure for waterp1meterkit-v1, moving configuration files to the appropriate directory.
  • Included instructions for enabling DSMR-Reader API and configuring it with the provided files.
  • Updated important notice regarding Wi-Fi and Ethernet configuration compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant