| Name | nodens-update JSON |
| Version |
24.3.2
JSON |
| download |
| home_page | None |
| Summary | Update a NodeNs sensor connected to the gateway |
| upload_time | 2024-03-27 19:04:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | The MIT License (MIT) Copyright (c) 2023 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 Update - is to update a NodeNs sensor configuration via the MQTT gateway. The new configuration will be defined through the file: ```config-gateway.yaml```.
## Change log
v24.3.2. Increased time delay again before config send. Adjusted some config parameters.
v24.3.1. Corrected error with scan rate. Time delay added before config send, to allow for old config receive.
v24.3.0. Added radar height, using *RADAR_HEIGHT*. The script also polls the radar for it's current configuration.
v24.2.0. Added custom radar calibrations to the configuration update, using *RADAR_CAL*.
## Installation
NodeNs Update can be installed using pip:
```
pip install nodens.update
```
### 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 Update can be executed directly from the command line as follows:
```
python -m nodens.update
```
It can also be imported as a library into your own scripts:
```import nodens.update```
On execution, as a first step it will search for the configuration file ```config-update.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
**SENSOR**
*ROOT_ID* : MAC address of the root sensor.
*SENSOR_ID* : MAC address of the sensor to be updated.
*SENSOR_IP* : IP address of the MQTT broker. Default = 10.3.141.1
*SENSOR_PORT* : Port. 1883 : unsecured. 8883: secured (security keys must be provided).
**DATA_TRANSMIT**
*TRANSMIT_TIME* : How often sensor data is sent via Wi-Fi, in seconds. Default = 2.
*FULL_DATA_FLAG* : Flag to capture full-data for diagnostics. Set to 1 to transmit full diagnostics data via Wi-Fi, such as point clouds and micro-Dopplers. Default = 0.
*FULL_DATA_TIME* : Seconds between full-data captures (must be a multiple of TRANSMIT_TIME). Default = 2.
**RADAR**
*RADAR_SEND_FLAG* : Flag to send new radar configuration. Set to 1 to update the radar configuration. Default = 0.
*ROOM_X_MIN* / *ROOM_X_MAX*: Monitoring size of area (room or virtual zone) to scan. -X/+X is to the left/right respectively, in meters, from the point-of-view of the sensor. The origin is at (0,0,0).
*ROOM_Y_MIN* / *ROOM_Y_MAX*: As above. By default, sensor points along Y-axis. +Y is looking forward, from the point-of-view of the sensor. **Y must be +ve**. The origin is at (0,0,0).
*ROOM_Z_MIN* / *ROOM_Z_MAX*: As above. Z-axis is room height. -Z/+Z is to the down/up respectively, in meters, from the point-of-view of the sensor. The origin is at (0,0,0).
Raw data
{
"_id": null,
"home_page": null,
"name": "nodens-update",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nodens, gateway, radar",
"author": null,
"author_email": "Khalid Z Rajab <khalid@nodens.eu>",
"download_url": "https://files.pythonhosted.org/packages/b0/9e/2be8b85d789bc382b446859d5c5a000c0ef2fffb1703b458ea74bf05dccc/nodens-update-24.3.2.tar.gz",
"platform": null,
"description": "The purpose of this program - NodeNs Update - is to update a NodeNs sensor configuration via the MQTT gateway. The new configuration will be defined through the file: ```config-gateway.yaml```.\r\n\r\n## Change log\r\n\r\nv24.3.2. Increased time delay again before config send. Adjusted some config parameters.\r\n\r\nv24.3.1. Corrected error with scan rate. Time delay added before config send, to allow for old config receive.\r\n\r\nv24.3.0. Added radar height, using *RADAR_HEIGHT*. The script also polls the radar for it's current configuration.\r\n\r\nv24.2.0. Added custom radar calibrations to the configuration update, using *RADAR_CAL*.\r\n\r\n## Installation\r\nNodeNs Update can be installed using pip:\r\n```\r\npip install nodens.update\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 Update can be executed directly from the command line as follows:\r\n```\r\npython -m nodens.update\r\n```\r\n\r\nIt can also be imported as a library into your own scripts:\r\n```import nodens.update```\r\n\r\nOn execution, as a first step it will search for the configuration file ```config-update.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**SENSOR**\r\n\r\n*ROOT_ID* : MAC address of the root sensor.\r\n*SENSOR_ID* : MAC address of the sensor to be updated.\r\n*SENSOR_IP* : IP address of the MQTT broker. Default = 10.3.141.1\r\n*SENSOR_PORT* : Port. 1883 : unsecured. 8883: secured (security keys must be provided).\r\n\r\n**DATA_TRANSMIT**\r\n\r\n*TRANSMIT_TIME* : How often sensor data is sent via Wi-Fi, in seconds. Default = 2.\r\n*FULL_DATA_FLAG* : Flag to capture full-data for diagnostics. Set to 1 to transmit full diagnostics data via Wi-Fi, such as point clouds and micro-Dopplers. Default = 0.\r\n*FULL_DATA_TIME* : Seconds between full-data captures (must be a multiple of TRANSMIT_TIME). Default = 2.\r\n\r\n**RADAR**\r\n*RADAR_SEND_FLAG* : Flag to send new radar configuration. Set to 1 to update the radar configuration. Default = 0.\r\n*ROOM_X_MIN* / *ROOM_X_MAX*: Monitoring size of area (room or virtual zone) to scan. -X/+X is to the left/right respectively, in meters, from the point-of-view of the sensor. The origin is at (0,0,0).\r\n*ROOM_Y_MIN* / *ROOM_Y_MAX*: As above. By default, sensor points along Y-axis. +Y is looking forward, from the point-of-view of the sensor. **Y must be +ve**. The origin is at (0,0,0).\r\n*ROOM_Z_MIN* / *ROOM_Z_MAX*: As above. Z-axis is room height. -Z/+Z is to the down/up respectively, in meters, from the point-of-view of the sensor. The origin is at (0,0,0).\r\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2023 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": "Update a NodeNs sensor connected to the gateway",
"version": "24.3.2",
"project_urls": {
"Homepage": "https://www.nodens.eu"
},
"split_keywords": [
"nodens",
" gateway",
" radar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b09e2be8b85d789bc382b446859d5c5a000c0ef2fffb1703b458ea74bf05dccc",
"md5": "b66103e143992c65d3ab12405ca1fe9f",
"sha256": "107c3414b78211916bec5bc923f233c901b2d7eea4728e192e30cb7800197228"
},
"downloads": -1,
"filename": "nodens-update-24.3.2.tar.gz",
"has_sig": false,
"md5_digest": "b66103e143992c65d3ab12405ca1fe9f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 36824,
"upload_time": "2024-03-27T19:04:12",
"upload_time_iso_8601": "2024-03-27T19:04:12.112711Z",
"url": "https://files.pythonhosted.org/packages/b0/9e/2be8b85d789bc382b446859d5c5a000c0ef2fffb1703b458ea74bf05dccc/nodens-update-24.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 19:04:12",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nodens-update"
}
