[](https://github.com/psf/black)
[](https://www.python.org/downloads/release/python-3110/)
[](https://pypi.org/project/NEMO-mqtt/)
[](https://gitlab.com/r-xyz/nemo-mqtt/-/commits/main)
[](https://gitlab.com/r-xyz/nemo-mqtt/-/releases)
# NEMO MQTT
This plugin for [NEMO](https://github.com/usnistgov/NEMO) adds support for [MQTT](https://mqtt.org/) interlocks.
# Compatibility:
NEMO >= 5.0.0 ----> NEMO MQTT >= 0.3
NEMO-CE >= 2.0.0 -----> NEMO MQTT >= 0.3
# Installation
- Install python module
```shell
pip install NEMO-mqtt[NEMO]
```
- Add `NEMO_mqtt` to `INSTALLED_APPS` in `settings.py`:
```python
INSTALLED_APPS = [
'...',
'NEMO_mqtt', # This needs to be before NEMO
'...'
'NEMO',
'...'
]
```
- Run migrations:
```shell
python manage.py migrate
```
# Usage
1. Navigate to the `Detailed Administration` page in the `Administration` menu.
2. Go to `Interlock cards` admin page, create a new item with the following parameters:
- Name: `MQTT_0` (you can choose anything else meaningful and unique for each server, e.g. `MQTT_0, MQTT_1, etc`)
- Server: `localhost`
- Port: `0`
- Category*: `MQTT`
- Enabled: `tick`
3. Go to `Mqtt interlock servers` admin page and add one item for each server you are willing to use:
- Under card, select the corresponding interlock card item: `MQTT_0:localhost`
- Fill other parameters according to your server authentication requirements.
4. Go to `Interlocks` admin page and add an interlock:
- Card: `MQTT:localhost`
- Channel: select a non-null unique number.
5. Go to `MQTT interlocks` admin page and add an MQTT interlock:
- Interlock: select the previously created interlock
- Fill the rest according to the parameters required by your interlock to operate
6. Repeat 4 & 5 as needed
7. Use as a normal interlock for doors/tools
8. Enjoy!
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/r-xyz/nemo-mqtt",
"name": "NEMO-mqtt",
"maintainer": "r-xyz",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "NEMO",
"author": "r-xyz",
"author_email": "",
"download_url": "",
"platform": null,
"description": "[](https://github.com/psf/black)\n[](https://www.python.org/downloads/release/python-3110/)\n[](https://pypi.org/project/NEMO-mqtt/)\n\n[](https://gitlab.com/r-xyz/nemo-mqtt/-/commits/main)\n[](https://gitlab.com/r-xyz/nemo-mqtt/-/releases)\n\n\n# NEMO MQTT\n\nThis plugin for [NEMO](https://github.com/usnistgov/NEMO) adds support for [MQTT](https://mqtt.org/) interlocks.\n\n# Compatibility:\n\nNEMO >= 5.0.0 ----> NEMO MQTT >= 0.3\n\nNEMO-CE >= 2.0.0 -----> NEMO MQTT >= 0.3\n\n\n\n# Installation\n\n\n- Install python module\n \n ```shell\n pip install NEMO-mqtt[NEMO]\n ```\n\n- Add `NEMO_mqtt` to `INSTALLED_APPS` in `settings.py`:\n\n ```python\n INSTALLED_APPS = [\n '...',\n 'NEMO_mqtt', # This needs to be before NEMO\n '...'\n 'NEMO',\n '...'\n ]\n ```\n- Run migrations:\n\n ```shell\n python manage.py migrate\n ```\n\n# Usage\n1. Navigate to the `Detailed Administration` page in the `Administration` menu.\n2. Go to `Interlock cards` admin page, create a new item with the following parameters:\n - Name: `MQTT_0` (you can choose anything else meaningful and unique for each server, e.g. `MQTT_0, MQTT_1, etc`)\n - Server: `localhost`\n - Port: `0`\n - Category*: `MQTT`\n - Enabled: `tick`\n3. Go to `Mqtt interlock servers` admin page and add one item for each server you are willing to use:\n - Under card, select the corresponding interlock card item: `MQTT_0:localhost`\n - Fill other parameters according to your server authentication requirements.\n4. Go to `Interlocks` admin page and add an interlock:\n - Card: `MQTT:localhost`\n - Channel: select a non-null unique number.\n5. Go to `MQTT interlocks` admin page and add an MQTT interlock:\n - Interlock: select the previously created interlock\n - Fill the rest according to the parameters required by your interlock to operate\n6. Repeat 4 & 5 as needed\n7. Use as a normal interlock for doors/tools\n8. Enjoy!\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MQTT plugin for NEMO",
"version": "0.3.5",
"project_urls": {
"Homepage": "https://gitlab.com/r-xyz/nemo-mqtt"
},
"split_keywords": [
"nemo"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "307b033d714fa427a63fd47e7ab833884a98f65fe45de302c266661b99e44ae0",
"md5": "5bcd7f32d75f874ea8c703f5e4a0d2a9",
"sha256": "5ef20f53d1c878b78b3bf5fe83710992962bbfa7f3b073f2fa8532872b2e8c17"
},
"downloads": -1,
"filename": "NEMO_mqtt-0.3.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5bcd7f32d75f874ea8c703f5e4a0d2a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6694,
"upload_time": "2023-12-02T12:28:26",
"upload_time_iso_8601": "2023-12-02T12:28:26.072436Z",
"url": "https://files.pythonhosted.org/packages/30/7b/033d714fa427a63fd47e7ab833884a98f65fe45de302c266661b99e44ae0/NEMO_mqtt-0.3.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-02 12:28:26",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "r-xyz",
"gitlab_project": "nemo-mqtt",
"lcname": "nemo-mqtt"
}
JSON