# openhasp-config-manager
A cli tool to manage all of your [openHASP](https://github.com/HASwitchPlate/openHASP) device configs in a centralized
place.
# Features
* [x] unlimited multi-device management
* [x] shared configuration between devices
* [x] jsonl preprocessing, which allows for
* [x] `//` comments within jsonl files
* [x] line breaks wherever you like
* [x] jinja2 templating within object values
* [x] local and globally scoped variables
* [x] validation of common mistakes for
* [x] jsonl objects
* [x] cmd files
* [x] simple configuration upload to the device(s)
* [x] automatic diffing to only update changed configuration files
* [x] git-style diff output for changed lines
* [x] API client (Web + MQTT)
* [x] execute commands on a plate
* [x] listen to events and state updates
```shell
> openhasp-config-manager -h
Usage: openhasp-config-manager [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
cmd Sends a command request to a device.
deploy Combines the generation and upload of a configuration.
generate Generates the output files for all devices in the given...
help Show this message and exit.
listen Sends a state update request to a device.
logs Prints the logs of a device.
screenshot Requests a screenshot from the given device and stores it...
shell Connects to the telnet server of a device.
state Sends a state update request to a device.
upload Uploads the previously generated configuration to their...
vars Prints the variables accessible in a given path.
```
# Disclaimer
**TL;DR: This project is still experimental.**
I do use openhasp-config-manager exclusively to configure all of my openHASP devices. I am in the
process of adding tests to everything to make it more reliable and have also added lots of features along the way.
However, there are definitely still a couple of things that do not yet work as intended. Error logs
might need some love to be able to figure out what you did wrong. If you like the
project, feel free to open an issue or PR to help me out.
# How to use
## Docker
```
docker run -it --rm \
--name openhasp-config-manager \
--user 1000:1000 \
-v "./openhasp-configs:/app/openhasp-configs" \
-v "./output:/app/output" \
ghcr.io/markusressel/openhasp-config-manager
```
## Installation
Since openhasp-config-manager needs some dependencies (see [here](/pyproject.toml)) it is
**recommended to install it inside a virtualenv**.
### venv-install
[venv-install](https://github.com/markusressel/venv-install) is a little helper tool to eas the
installation, management and usage of python cli tools in venvs.
```bash
venv-install openhasp-config-manager openhasp-config-manager
openhasp-config-manager -h
```
### Manual
```bash
mkdir -p ~/venvs/openhasp-config-manager
python3 -m venv ~/venvs/openhasp-config-manager
source ~/venvs/openhasp-config-manager/bin/activate
pip3 install openhasp-config-manager
```
And to use it:
```shell
source ~/venvs/openhasp-config-manager/bin/activate
openhasp-config-manager -h
openhasp-config-manager analyze -c "./openhasp-configs"
...
```
### Uninstall
```bash
deactivate
rm -rf ~/venvs/openhasp-config-manager
```
## Configuration
openhasp-config-manager is first and foremost a configuration
management system. Simply follow the basic folder structure and
config deployment will become trivial. **Please read all of this,
as it is very important to understand the basic structure on
which everything relies.**
### Folder Structure
The following folders should reside inside a single parent
folder, f.ex. named `openhasp-configs`. This folder can be
located anywhere you like, but must be accessible to
openhasp-config-manager when executing.
* `common`: The `common` subdirectory can be used for files
that should be included on _all_ device. This folder is optional.
* `devices`: The `devices` folder is required. It must contain one
subfolder for each openHASP device you want to configure using
openhasp-config-manager. It is recommended to name subfolders according
to the physical devices associated with them.
* `touch_down_1` (example device folder)
* A device folder contains `*.jsonl`, `*.cmd` and other files which should
only be uploaded to that particular device.
* You can create arbitrary nested folder structures for organizing the files.
There is a limit to the file name length though,
see [FAQ](#output-file-name-length-must-not-exceed-30-characters)
* You must provide a `config.json` file, see [config.json](#config.json)
for more info.
A more advanced configuration layout could look something like this:
```text
openhasp-configs
├── common
│ ├── content
│ │ └── card.jsonl
│ ├── dialog
│ │ ├── connected.jsonl
│ │ └── offline.jsonl
│ ├── navigation_bar.jsonl
│ └── page_header.jsonl
└── devices
└── touch_down_1
├── 0_home
│ ├── 0_header.jsonl
│ ├── 1_content.jsonl
│ └── page.cmd
├── 5_about
│ ├── 0_header.jsonl
│ ├── 1_content.jsonl
│ └── page.cmd
├── boot.cmd
├── config.json
├── offline.cmd
└── online.cmd
```
### config.json
openhasp-config-manager makes use of the `config.json` on your plate. It can extract information
from it to detect things like screen orientation, and also allows you to deploy changes within the
`config.json` file. Since [the official API does not support
uploading the full file](https://github.com/HASwitchPlate/openHASP/issues/363), only settings
which can also be set through the web ui on the plate itself are currently supported.
To retrieve the initial version of the `config.json` file you can use the
built-in file browser integrated into the webserver of your openHASP plate, see
[official docs](https://www.openhasp.com/latest/faq/?h=web#is-there-a-file-browser-built-in).
The official `config.json` file doesn't provide enough info for openhasp-config-manager
to enable all of its features though. To fix that simply add a section to the
file after downloading it:
```json
{
"openhasp_config_manager": {
"device": {
"ip": "192.168.5.134",
"screen": {
"width": 320,
"height": 480
}
}
},
"wifi": {
"ssid": "Turris IoT",
...
}
```
### Config File Preprocessing
openhasp-config-manager runs all configuration files through various preprocessors, which allow us to use
features the original file formats do not support by themselves, like f.ex. templating.
#### Multiline JSONL files
While the JSONL file format requires each object to be on a single line, openhasp-config-manager
allows you to add as many line breaks as you wish. This makes it much easier to edit, since a config
like this:
```json
{
"page": 0,
"id": 31,
"obj": "msgbox",
"text": "%ip%",
"auto_close": 5000
}
```
will be deployed like this:
```json lines
{
"page": 0,
"id": 31,
"obj": "msgbox",
"text": "%ip%",
"auto_close": 5000
}
```
#### Comments
Neither JSON nor JSONL allows comments, but openhasp-config-manager does!
You can mark comments by prefixing them with a double forward-slash:
```json5
// File description
{
// Object Description
"page": 0,
"id": 31,
// Property Description
"obj": "msgbox",
"text": "%ip%",
"auto_close": 5000
}
```
#### Templating
You can use Jinja2 templates inside all jsonl object values. To access the value of another object in a
template, you can use the `pXbY` syntax established by openHASP, where `X` is the `page` of an object and
`Y` is its `id`. openhasp-config-manager even tries to resolve templates that lead to other templates.
Be careful not to create loops in this way though.
You can use the full functionality of Jinja2 like f.ex. math operations, function calls or type conversions.
```yaml
{
"page": 1,
"id": 1,
"x": 0,
"y": 0,
...
}
{
"page": 1,
"id": 2,
"x": "{{ p1b1.x }}",
"y": "{{ p1b1.y + 10 }}",
...
}
```
#### Variables
Besides accessing other objects, you can also define custom variables yourself, which can then
be referenced inside of templates. Variables are defined using `*.yaml` files. If you
decided to use a subfolder structure to organize your configuration files you can use these folders
to also set the scope of variables. More specific variable definitions (longer path) will override
less specific ones.
##### Global
Global variables can be specified by creating `*.yaml` files inside the root config folder (f.ex. `openhasp-configs`).
Example:
`openhasp-configs/global.vars.yaml`
```yaml
about:
page_title: "About"
```
To access this variable, use a Jinja2 template:
`openhasp-configs/common/about_page.jsonl`
```json lines
{
"page": 9,
"id": 1,
...
"title": "{{ about.page_title }}",
...
}
```
##### Device specific
Device specific variables can be specified by creating `*.yaml` files inside any of the sub-folders
of a `device` folder.
> **Note**
>
> Device specific variables will override global variables, given the same name.
Example:
`openhasp-configs/device/my_device/device.vars.yaml`
```yaml
page_title: "My Device"
```
`openhasp-configs/device/my_device/some_folder/some_page.jsonl`
```json lines
{
"page": 1,
"id": 1,
...
"title": "{{ page_title }}",
...
}
```
`openhasp-configs/device/my_device/some_other_folder/some_page.jsonl`
```json lines
{
"page": 2,
"id": 1,
...
"title": "{{ page_title }}",
...
}
```
#### Printing variables
If you are not sure what variables are accessible in a given path, you can use the `vars`
command, which will give you a copy&paste ready output of all variables for a
given directory:
```shell
> openhasp-config-manager vars -c openhasp-configs -p devices/touch_down_1/home
common.navbar.first_page: 1
common.navbar.last_page: 4
...
header.title: Home
```
## Deployment
To deploy your configurations to the already connected openHASP devices, simply use the
`generate`, `upload` or `deploy` commands of `openhasp-config-manager`.
> **Note**
> openhasp-config-manager needs direct IP access as well as an enabled webservice on the plate
> to be able to deploy files to the device. To enable the webservice
> try: `openhasp-config-manager cmd -d plate35 -C service -p "start http"`
## Run commands
While openhasp-config-manager is first and foremost a config management system,
it also allows you to run commands on a device by issuing MQTT messages without the need to install a separate
MQTT client first. Note that the MQTT _server_ still needs to be running and also has to
be reachable from your local machine for this to work.
For a list of possible commands to send to a device, take a look at the official
documentation: https://openhasp.haswitchplate.com/latest/commands/
```shell
> openhasp-config-manager cmd -c ./openhasp-configs -d plate35 -C backlight -p "{\"state\":\"on\",\"brightness\":128}"
```
# FAQ
## How do I see device logs?
Try the `logs` command (this does require network access to the device):
```shell
> openhasp-config-manager logs -d plate35
```
If that doesn't work, open a terminal and run the following command with the device connected via USB cable:
```shell
bash -c "screen -q -L -Logfile device.log /dev/ttyUSB0 115200 &> /dev/null; tail -F device.log; killall screen"
```
## Output file name length must not exceed 30 characters
If you want to organize your files (both common and device-specific ones) you can
simply create subfolders to achieve your desired structure. However, due to a technical
limitation openHASP does not support subfolder on the actual device. To overcome
this limitation openhasp-config-manager will automatically generate a file name for
files in subfolders before uploading them to the device. `.json` or `.cmd` files within subfolders
will be renamed by concatenating their full subpath using an underscore (`_`) as a separator. So f.ex.
the file in the following structure:
```text
openhasp-configs
└── devices
└── touch_down_1
└── 0_home
└── 0_header.jsonl
```
would be uploaded to the `touch_down_1` device with the name `0_home_0_header.jsonl`.
# Contributing
GitHub is for social coding: if you want to write code, I encourage contributions
through pull requests from forks of this repository. Create GitHub tickets for
bugs and new features and comment on the ones that you are interested in.
# License
```text
openhasp-config-manager is free software: you can redistribute it and/or modify
it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/markusressel/openhasp-config-manager",
"name": "openhasp-config-manager",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "openhasp,config,management",
"author": "Markus Ressel",
"author_email": "mail@markusressel.de",
"download_url": "https://files.pythonhosted.org/packages/f0/59/336135821414c38ede4e0904c8dd3fffd07af203914b5498cd2a585ec6fe/openhasp_config_manager-0.5.0.tar.gz",
"platform": null,
"description": "# openhasp-config-manager\n\nA cli tool to manage all of your [openHASP](https://github.com/HASwitchPlate/openHASP) device configs in a centralized\nplace.\n\n# Features\n\n* [x] unlimited multi-device management\n* [x] shared configuration between devices\n* [x] jsonl preprocessing, which allows for\n * [x] `//` comments within jsonl files\n * [x] line breaks wherever you like\n * [x] jinja2 templating within object values\n * [x] local and globally scoped variables\n* [x] validation of common mistakes for\n * [x] jsonl objects\n * [x] cmd files\n* [x] simple configuration upload to the device(s)\n * [x] automatic diffing to only update changed configuration files\n * [x] git-style diff output for changed lines\n* [x] API client (Web + MQTT)\n * [x] execute commands on a plate\n * [x] listen to events and state updates\n\n```shell\n> openhasp-config-manager -h\nUsage: openhasp-config-manager [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --version Show the version and exit.\n -h, --help Show this message and exit.\n\nCommands:\n cmd Sends a command request to a device.\n deploy Combines the generation and upload of a configuration.\n generate Generates the output files for all devices in the given...\n help Show this message and exit.\n listen Sends a state update request to a device.\n logs Prints the logs of a device.\n screenshot Requests a screenshot from the given device and stores it...\n shell Connects to the telnet server of a device.\n state Sends a state update request to a device.\n upload Uploads the previously generated configuration to their...\n vars Prints the variables accessible in a given path.\n```\n\n# Disclaimer\n\n**TL;DR: This project is still experimental.**\n\nI do use openhasp-config-manager exclusively to configure all of my openHASP devices. I am in the\nprocess of adding tests to everything to make it more reliable and have also added lots of features along the way.\nHowever, there are definitely still a couple of things that do not yet work as intended. Error logs\nmight need some love to be able to figure out what you did wrong. If you like the\nproject, feel free to open an issue or PR to help me out.\n\n# How to use\n\n## Docker\n\n```\ndocker run -it --rm \\\n --name openhasp-config-manager \\\n --user 1000:1000 \\\n -v \"./openhasp-configs:/app/openhasp-configs\" \\\n -v \"./output:/app/output\" \\\n ghcr.io/markusressel/openhasp-config-manager\n```\n\n## Installation\n\nSince openhasp-config-manager needs some dependencies (see [here](/pyproject.toml)) it is\n**recommended to install it inside a virtualenv**.\n\n### venv-install\n\n[venv-install](https://github.com/markusressel/venv-install) is a little helper tool to eas the\ninstallation, management and usage of python cli tools in venvs.\n\n```bash\nvenv-install openhasp-config-manager openhasp-config-manager\nopenhasp-config-manager -h\n```\n\n### Manual\n\n```bash\nmkdir -p ~/venvs/openhasp-config-manager\npython3 -m venv ~/venvs/openhasp-config-manager\nsource ~/venvs/openhasp-config-manager/bin/activate\npip3 install openhasp-config-manager\n```\n\nAnd to use it:\n\n```shell\nsource ~/venvs/openhasp-config-manager/bin/activate\nopenhasp-config-manager -h\nopenhasp-config-manager analyze -c \"./openhasp-configs\"\n...\n```\n\n### Uninstall\n\n```bash\ndeactivate\nrm -rf ~/venvs/openhasp-config-manager\n```\n\n## Configuration\n\nopenhasp-config-manager is first and foremost a configuration\nmanagement system. Simply follow the basic folder structure and\nconfig deployment will become trivial. **Please read all of this,\nas it is very important to understand the basic structure on\nwhich everything relies.**\n\n### Folder Structure\n\nThe following folders should reside inside a single parent\nfolder, f.ex. named `openhasp-configs`. This folder can be\nlocated anywhere you like, but must be accessible to\nopenhasp-config-manager when executing.\n\n* `common`: The `common` subdirectory can be used for files\n that should be included on _all_ device. This folder is optional.\n* `devices`: The `devices` folder is required. It must contain one\n subfolder for each openHASP device you want to configure using\n openhasp-config-manager. It is recommended to name subfolders according\n to the physical devices associated with them.\n * `touch_down_1` (example device folder)\n * A device folder contains `*.jsonl`, `*.cmd` and other files which should\n only be uploaded to that particular device.\n * You can create arbitrary nested folder structures for organizing the files.\n There is a limit to the file name length though,\n see [FAQ](#output-file-name-length-must-not-exceed-30-characters)\n * You must provide a `config.json` file, see [config.json](#config.json)\n for more info.\n\nA more advanced configuration layout could look something like this:\n\n```text\nopenhasp-configs\n\u251c\u2500\u2500 common\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 content\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 card.jsonl\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 dialog\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u251c\u2500\u2500 connected.jsonl\n\u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 offline.jsonl\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 navigation_bar.jsonl\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 page_header.jsonl\n\u2514\u2500\u2500 devices\n \u2514\u2500\u2500 touch_down_1\n \u251c\u2500\u2500 0_home\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 0_header.jsonl\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 1_content.jsonl\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 page.cmd\n \u251c\u2500\u2500 5_about\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 0_header.jsonl\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 1_content.jsonl\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 page.cmd\n \u251c\u2500\u2500 boot.cmd\n \u251c\u2500\u2500 config.json\n \u251c\u2500\u2500 offline.cmd\n \u2514\u2500\u2500 online.cmd\n```\n\n### config.json\n\nopenhasp-config-manager makes use of the `config.json` on your plate. It can extract information\nfrom it to detect things like screen orientation, and also allows you to deploy changes within the\n`config.json` file. Since [the official API does not support\nuploading the full file](https://github.com/HASwitchPlate/openHASP/issues/363), only settings\nwhich can also be set through the web ui on the plate itself are currently supported.\n\nTo retrieve the initial version of the `config.json` file you can use the\nbuilt-in file browser integrated into the webserver of your openHASP plate, see\n[official docs](https://www.openhasp.com/latest/faq/?h=web#is-there-a-file-browser-built-in).\n\nThe official `config.json` file doesn't provide enough info for openhasp-config-manager\nto enable all of its features though. To fix that simply add a section to the\nfile after downloading it:\n\n```json\n{\n \"openhasp_config_manager\": {\n \"device\": {\n \"ip\": \"192.168.5.134\",\n \"screen\": {\n \"width\": 320,\n \"height\": 480\n }\n }\n },\n \"wifi\": {\n \"ssid\": \"Turris IoT\",\n ...\n }\n```\n\n### Config File Preprocessing\n\nopenhasp-config-manager runs all configuration files through various preprocessors, which allow us to use\nfeatures the original file formats do not support by themselves, like f.ex. templating.\n\n#### Multiline JSONL files\n\nWhile the JSONL file format requires each object to be on a single line, openhasp-config-manager\nallows you to add as many line breaks as you wish. This makes it much easier to edit, since a config\nlike this:\n\n```json\n{\n \"page\": 0,\n \"id\": 31,\n \"obj\": \"msgbox\",\n \"text\": \"%ip%\",\n \"auto_close\": 5000\n}\n```\n\nwill be deployed like this:\n\n```json lines\n{\n \"page\": 0,\n \"id\": 31,\n \"obj\": \"msgbox\",\n \"text\": \"%ip%\",\n \"auto_close\": 5000\n}\n```\n\n#### Comments\n\nNeither JSON nor JSONL allows comments, but openhasp-config-manager does!\nYou can mark comments by prefixing them with a double forward-slash:\n\n```json5\n// File description\n{\n // Object Description\n \"page\": 0,\n \"id\": 31,\n // Property Description\n \"obj\": \"msgbox\",\n \"text\": \"%ip%\",\n \"auto_close\": 5000\n}\n```\n\n#### Templating\n\nYou can use Jinja2 templates inside all jsonl object values. To access the value of another object in a\ntemplate, you can use the `pXbY` syntax established by openHASP, where `X` is the `page` of an object and\n`Y` is its `id`. openhasp-config-manager even tries to resolve templates that lead to other templates.\nBe careful not to create loops in this way though.\n\nYou can use the full functionality of Jinja2 like f.ex. math operations, function calls or type conversions.\n\n```yaml\n{\n \"page\": 1,\n \"id\": 1,\n \"x\": 0,\n \"y\": 0,\n ...\n}\n\n {\n \"page\": 1,\n \"id\": 2,\n \"x\": \"{{ p1b1.x }}\",\n \"y\": \"{{ p1b1.y + 10 }}\",\n ...\n }\n```\n\n#### Variables\n\nBesides accessing other objects, you can also define custom variables yourself, which can then\nbe referenced inside of templates. Variables are defined using `*.yaml` files. If you\ndecided to use a subfolder structure to organize your configuration files you can use these folders\nto also set the scope of variables. More specific variable definitions (longer path) will override\nless specific ones.\n\n##### Global\n\nGlobal variables can be specified by creating `*.yaml` files inside the root config folder (f.ex. `openhasp-configs`).\n\nExample:\n\n`openhasp-configs/global.vars.yaml`\n\n```yaml\nabout:\n page_title: \"About\"\n```\n\nTo access this variable, use a Jinja2 template:\n\n`openhasp-configs/common/about_page.jsonl`\n\n```json lines\n{\n \"page\": 9,\n \"id\": 1,\n ...\n \"title\": \"{{ about.page_title }}\",\n ...\n}\n```\n\n##### Device specific\n\nDevice specific variables can be specified by creating `*.yaml` files inside any of the sub-folders\nof a `device` folder.\n\n> **Note**\n>\n> Device specific variables will override global variables, given the same name.\n\nExample:\n\n`openhasp-configs/device/my_device/device.vars.yaml`\n\n```yaml\npage_title: \"My Device\"\n```\n\n`openhasp-configs/device/my_device/some_folder/some_page.jsonl`\n\n```json lines\n{\n \"page\": 1,\n \"id\": 1,\n ...\n \"title\": \"{{ page_title }}\",\n ...\n}\n```\n\n`openhasp-configs/device/my_device/some_other_folder/some_page.jsonl`\n\n```json lines\n{\n \"page\": 2,\n \"id\": 1,\n ...\n \"title\": \"{{ page_title }}\",\n ...\n}\n```\n\n#### Printing variables\n\nIf you are not sure what variables are accessible in a given path, you can use the `vars`\ncommand, which will give you a copy&paste ready output of all variables for a\ngiven directory:\n\n```shell\n> openhasp-config-manager vars -c openhasp-configs -p devices/touch_down_1/home\ncommon.navbar.first_page: 1\ncommon.navbar.last_page: 4\n...\nheader.title: Home\n```\n\n## Deployment\n\nTo deploy your configurations to the already connected openHASP devices, simply use the\n`generate`, `upload` or `deploy` commands of `openhasp-config-manager`.\n\n> **Note**\n> openhasp-config-manager needs direct IP access as well as an enabled webservice on the plate\n> to be able to deploy files to the device. To enable the webservice\n> try: `openhasp-config-manager cmd -d plate35 -C service -p \"start http\"`\n\n## Run commands\n\nWhile openhasp-config-manager is first and foremost a config management system,\nit also allows you to run commands on a device by issuing MQTT messages without the need to install a separate\nMQTT client first. Note that the MQTT _server_ still needs to be running and also has to\nbe reachable from your local machine for this to work.\n\nFor a list of possible commands to send to a device, take a look at the official\ndocumentation: https://openhasp.haswitchplate.com/latest/commands/\n\n```shell\n> openhasp-config-manager cmd -c ./openhasp-configs -d plate35 -C backlight -p \"{\\\"state\\\":\\\"on\\\",\\\"brightness\\\":128}\"\n```\n\n# FAQ\n\n## How do I see device logs?\n\nTry the `logs` command (this does require network access to the device):\n\n```shell\n> openhasp-config-manager logs -d plate35\n```\n\nIf that doesn't work, open a terminal and run the following command with the device connected via USB cable:\n\n```shell\nbash -c \"screen -q -L -Logfile device.log /dev/ttyUSB0 115200 &> /dev/null; tail -F device.log; killall screen\"\n```\n\n## Output file name length must not exceed 30 characters\n\nIf you want to organize your files (both common and device-specific ones) you can\nsimply create subfolders to achieve your desired structure. However, due to a technical\nlimitation openHASP does not support subfolder on the actual device. To overcome\nthis limitation openhasp-config-manager will automatically generate a file name for\nfiles in subfolders before uploading them to the device. `.json` or `.cmd` files within subfolders\nwill be renamed by concatenating their full subpath using an underscore (`_`) as a separator. So f.ex.\nthe file in the following structure:\n\n```text\nopenhasp-configs\n\u2514\u2500\u2500 devices\n \u2514\u2500\u2500 touch_down_1\n \u2514\u2500\u2500 0_home\n \u2514\u2500\u2500 0_header.jsonl\n```\n\nwould be uploaded to the `touch_down_1` device with the name `0_home_0_header.jsonl`.\n\n# Contributing\n\nGitHub is for social coding: if you want to write code, I encourage contributions\nthrough pull requests from forks of this repository. Create GitHub tickets for\nbugs and new features and comment on the ones that you are interested in.\n\n# License\n\n```text\nopenhasp-config-manager is free software: you can redistribute it and/or modify\nit under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n```\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "A tool to manage all of your openHASP device configs in a centralized place.",
"version": "0.5.0",
"split_keywords": [
"openhasp",
"config",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08685b62be2e36ed3ac8f6ce7f4ba63f6ddc531ef9152389d2595053038063b2",
"md5": "625962475c8afefeab36556210a2a309",
"sha256": "267b67bdd42bfa308c2d376845080129638665b09d08673c83e05f71f3a6c982"
},
"downloads": -1,
"filename": "openhasp_config_manager-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "625962475c8afefeab36556210a2a309",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 62707,
"upload_time": "2023-04-16T00:02:29",
"upload_time_iso_8601": "2023-04-16T00:02:29.306201Z",
"url": "https://files.pythonhosted.org/packages/08/68/5b62be2e36ed3ac8f6ce7f4ba63f6ddc531ef9152389d2595053038063b2/openhasp_config_manager-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f059336135821414c38ede4e0904c8dd3fffd07af203914b5498cd2a585ec6fe",
"md5": "3912024dbf177585e927ce86ebecccab",
"sha256": "df61174e7f3f7a12be4eb7e258f20c50f77a50feee1c999c0531a4bf025f1115"
},
"downloads": -1,
"filename": "openhasp_config_manager-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "3912024dbf177585e927ce86ebecccab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 48385,
"upload_time": "2023-04-16T00:02:31",
"upload_time_iso_8601": "2023-04-16T00:02:31.544665Z",
"url": "https://files.pythonhosted.org/packages/f0/59/336135821414c38ede4e0904c8dd3fffd07af203914b5498cd2a585ec6fe/openhasp_config_manager-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-16 00:02:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "markusressel",
"github_project": "openhasp-config-manager",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "openhasp-config-manager"
}
JSON
