| Name | nodens-gateway JSON |
| Version |
24.3.6
JSON |
| download |
| home_page | |
| Summary | Run the NodeNs gateway |
| upload_time | 2024-03-03 13:07:58 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | The MIT License (MIT) Copyright (c) 2024 Khalid Rajab and NodeNs Medical Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
nodens
gateway
radar
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
The purpose of this program - NodeNs Gateway - is to operate an MQTT gateway for connection to NodeNs sensors. The gateway will detect NodeNs sensors connected to the MQTT host, process their data, and optionally publish to a Cloud service and/or save to local storage.
## Installation
NodeNs Gateway can be installed using pip:
```
pip install nodens.gateway
```
### Troubleshooting
**Installing PyYaml**. Pip sometimes has trouble installing the PyYaml package. If you experience this, it may be easier to install it manually:
```
pip install pyyaml
```
## Operation
NodeNs Gateway can be executed directly from the command line as follows:
```
python -m nodens.gateway
```
It can also be imported as a library into your own scripts:
```import nodens.gateway```
On execution, as a first step it will search for the configuration file ```config-gateway.yaml``` to define the MQTT broker and other basic settings. The program will first search for the config file in the User's (your) default config folder, and then in the folder you've executed the program from. If the config file is not found, it will create one based on a default configuration. [Click here for details of the Configuration](##Configuration).
If a Cloud service operation has been specified, the script will also search for relevant access tokens or certificates.
## Configuration
### Location of configuration file
The program will search for the configuration file ```config-gateway.yaml``` in the following order:
1. In the user config folder, e.g.
- Windows: */Users/\<user>/AppData/Local/NodeNs/Gateway/*
- Unix: *~/.config/Gateway/*
2. In the current working folder.
3. In *<System documents folder>/NodeNs/*
4. In *<System documents folder>/*
5. Otherwise, a default config file will be created in the user folder, and the program will print its location. Feel free to edit it as necessary!
### Description of settings
**Program**
*WRITE_FLAG* : Set to *1* if you require sensor data to be saved to disk. Data will be saved in csv form to: *\<current folder>/Saved/*
*CLOUD_WRITE_TIME* : How often data is saved to a Cloud service (if activated)
**Sensor**
*Sensor_IP* : IP address of the MQTT broker. _Default_: 10.3.141.1.
# Thingsboard setup
Thingsboard provisioning: https://thingsboard.io/docs/paas/getting-started-guides/helloworld/#step-1-provision-device
Raw data
{
"_id": null,
"home_page": "",
"name": "nodens-gateway",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nodens,gateway,radar",
"author": "",
"author_email": "Khalid Z Rajab <khalid@nodens.eu>",
"download_url": "https://files.pythonhosted.org/packages/f4/c4/e5e89a873e5ea17f10478c5ddc02b74f04d14cf09d88d673bd6b1d00307d/nodens-gateway-24.3.6.tar.gz",
"platform": null,
"description": "The purpose of this program - NodeNs Gateway - is to operate an MQTT gateway for connection to NodeNs sensors. The gateway will detect NodeNs sensors connected to the MQTT host, process their data, and optionally publish to a Cloud service and/or save to local storage.\r\n\r\n## Installation\r\nNodeNs Gateway can be installed using pip:\r\n```\r\npip install nodens.gateway\r\n```\r\n\r\n### Troubleshooting\r\n**Installing PyYaml**. Pip sometimes has trouble installing the PyYaml package. If you experience this, it may be easier to install it manually:\r\n```\r\npip install pyyaml\r\n```\r\n\r\n## Operation\r\nNodeNs Gateway can be executed directly from the command line as follows:\r\n```\r\npython -m nodens.gateway\r\n```\r\n\r\nIt can also be imported as a library into your own scripts:\r\n```import nodens.gateway```\r\n\r\nOn execution, as a first step it will search for the configuration file ```config-gateway.yaml``` to define the MQTT broker and other basic settings. The program will first search for the config file in the User's (your) default config folder, and then in the folder you've executed the program from. If the config file is not found, it will create one based on a default configuration. [Click here for details of the Configuration](##Configuration).\r\n\r\nIf a Cloud service operation has been specified, the script will also search for relevant access tokens or certificates.\r\n\r\n## Configuration\r\n### Location of configuration file \r\nThe program will search for the configuration file ```config-gateway.yaml``` in the following order:\r\n\r\n1. In the user config folder, e.g.\r\n - Windows: */Users/\\<user>/AppData/Local/NodeNs/Gateway/*\r\n - Unix: *~/.config/Gateway/*\r\n2. In the current working folder.\r\n3. In *<System documents folder>/NodeNs/*\r\n4. In *<System documents folder>/*\r\n5. Otherwise, a default config file will be created in the user folder, and the program will print its location. Feel free to edit it as necessary!\r\n\r\n### Description of settings\r\n\r\n**Program**\r\n\r\n*WRITE_FLAG* : Set to *1* if you require sensor data to be saved to disk. Data will be saved in csv form to: *\\<current folder>/Saved/*\r\n*CLOUD_WRITE_TIME* : How often data is saved to a Cloud service (if activated)\r\n\r\n**Sensor**\r\n\r\n*Sensor_IP* : IP address of the MQTT broker. _Default_: 10.3.141.1.\r\n\r\n\r\n# Thingsboard setup\r\nThingsboard provisioning: https://thingsboard.io/docs/paas/getting-started-guides/helloworld/#step-1-provision-device\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2024 Khalid Rajab and NodeNs Medical Ltd. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Run the NodeNs gateway",
"version": "24.3.6",
"project_urls": {
"Homepage": "https://www.nodens.eu"
},
"split_keywords": [
"nodens",
"gateway",
"radar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4c4e5e89a873e5ea17f10478c5ddc02b74f04d14cf09d88d673bd6b1d00307d",
"md5": "8f04fc1bb0c59d7bdf9d560dc3de46cb",
"sha256": "abab50359aadf31ad0258b45a99ad1de835f71336af93d6d7f660f954ecd55f6"
},
"downloads": -1,
"filename": "nodens-gateway-24.3.6.tar.gz",
"has_sig": false,
"md5_digest": "8f04fc1bb0c59d7bdf9d560dc3de46cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 35499,
"upload_time": "2024-03-03T13:07:58",
"upload_time_iso_8601": "2024-03-03T13:07:58.352443Z",
"url": "https://files.pythonhosted.org/packages/f4/c4/e5e89a873e5ea17f10478c5ddc02b74f04d14cf09d88d673bd6b1d00307d/nodens-gateway-24.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-03 13:07:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nodens-gateway"
}
