| Name | smartmeter-webthing JSON |
| Version |
1.2.32
JSON |
| download |
| home_page | |
| Summary | Smartmeter WebThing |
| upload_time | 2023-10-24 19:51:17 |
| maintainer | |
| docs_url | None |
| author | Gregor Roth |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# smart meter webthing
A webthing connector for smart meters
This project provides a smart meter [webthing API](https://webthings.io/). It provides the software to connect an [IR USB sensor](https://wiki.volkszaehler.org/hardware/controllers/ir-schreib-lesekopf-usb-ausgang)
<img src="img.png" height="350" />
The smart meter webthing package provides an http webthing endpoint that supports smart meter consumption values over http. e.g.
```
# webthing has been started on host 192.168.0.23
curl http://192.168.0.23:7122/properties
{
"current_power": 389,
"produced_power_total": 3314.7,
"consumed_power_total": 259784.2
}
```
To install this software, you can use the [PIP](https://realpython.com/what-is-pip/) package manager as shown below
```
sudo pip install smartmeter_webthing
```
After installation, you can start the webthing http endpoint in your Python code or from the command line by typing
```
sudo smartmeter --command listen --port 7122 --sport /dev/serial/by-id/usb-Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_0051-if00-port0
```
Here the webthing API will use the local port 7122. Additionally, the device address of the IR sensor must be set. To configure the device address, see [setup device](configure.md).
As an alternative to the *list* command, you can also use the *register* command to register and start the webthing service as a systemd device.
This way, the webthing service is started automatically at boot time. Starting the server manually with the *listen* command, as shown above, is no longer necessary.
```
sudo smartmeter --command register --port 7122 --sport /dev/serial/by-id/usb-Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_0051-if00-port0
```
Raw data
{
"_id": null,
"home_page": "",
"name": "smartmeter-webthing",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Gregor Roth",
"author_email": "gregor.roth@web.de",
"download_url": "https://files.pythonhosted.org/packages/7d/e5/0c667ad1997bce71520ad14f7b12121f7ebddeffa25d60c8a3c0c3f00d25/smartmeter_webthing-1.2.32.tar.gz",
"platform": null,
"description": "# smart meter webthing\nA webthing connector for smart meters\n\nThis project provides a smart meter [webthing API](https://webthings.io/). It provides the software to connect an [IR USB sensor](https://wiki.volkszaehler.org/hardware/controllers/ir-schreib-lesekopf-usb-ausgang)\n\n<img src=\"img.png\" height=\"350\" />\n\nThe smart meter webthing package provides an http webthing endpoint that supports smart meter consumption values over http. e.g.\n```\n# webthing has been started on host 192.168.0.23\n\ncurl http://192.168.0.23:7122/properties \n\n{\n \"current_power\": 389,\n \"produced_power_total\": 3314.7,\n \"consumed_power_total\": 259784.2\n}\n```\n\nTo install this software, you can use the [PIP](https://realpython.com/what-is-pip/) package manager as shown below\n```\nsudo pip install smartmeter_webthing\n```\n\nAfter installation, you can start the webthing http endpoint in your Python code or from the command line by typing\n```\nsudo smartmeter --command listen --port 7122 --sport /dev/serial/by-id/usb-Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_0051-if00-port0\n```\nHere the webthing API will use the local port 7122. Additionally, the device address of the IR sensor must be set. To configure the device address, see [setup device](configure.md).\n\nAs an alternative to the *list* command, you can also use the *register* command to register and start the webthing service as a systemd device.\nThis way, the webthing service is started automatically at boot time. Starting the server manually with the *listen* command, as shown above, is no longer necessary.\n\n```\nsudo smartmeter --command register --port 7122 --sport /dev/serial/by-id/usb-Silicon_Labs_CP2102_USB_to_UART_Bridge_Controller_0051-if00-port0\n``` \n",
"bugtrack_url": null,
"license": "",
"summary": "Smartmeter WebThing",
"version": "1.2.32",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e32df7b6b1427c764e0154ee9f72b5b49e9e9ae5ec8c2c205236e5cf41dcb293",
"md5": "048e981ede5944e726e7300d13783f63",
"sha256": "bf29de03f12b474b3f2602da480c4c44f964dddef4e9023f25fffdb110f4a98d"
},
"downloads": -1,
"filename": "smartmeter_webthing-1.2.32-py3-none-any.whl",
"has_sig": false,
"md5_digest": "048e981ede5944e726e7300d13783f63",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13589,
"upload_time": "2023-10-24T19:51:15",
"upload_time_iso_8601": "2023-10-24T19:51:15.882705Z",
"url": "https://files.pythonhosted.org/packages/e3/2d/f7b6b1427c764e0154ee9f72b5b49e9e9ae5ec8c2c205236e5cf41dcb293/smartmeter_webthing-1.2.32-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7de50c667ad1997bce71520ad14f7b12121f7ebddeffa25d60c8a3c0c3f00d25",
"md5": "626a5630858512c6be8599d30c85be11",
"sha256": "22f8c431294f4410c089c385d4a7b062429da591b0364a41e248e65c1efb38e2"
},
"downloads": -1,
"filename": "smartmeter_webthing-1.2.32.tar.gz",
"has_sig": false,
"md5_digest": "626a5630858512c6be8599d30c85be11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12944,
"upload_time": "2023-10-24T19:51:17",
"upload_time_iso_8601": "2023-10-24T19:51:17.880214Z",
"url": "https://files.pythonhosted.org/packages/7d/e5/0c667ad1997bce71520ad14f7b12121f7ebddeffa25d60c8a3c0c3f00d25/smartmeter_webthing-1.2.32.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 19:51:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "smartmeter-webthing"
}
