{"id":21611293,"url":"https://github.com/runnerty/executor-mqtt","last_synced_at":"2026-01-11T01:29:24.630Z","repository":{"id":54617167,"uuid":"312656517","full_name":"runnerty/executor-mqtt","owner":"runnerty","description":"Runnerty module: MQTT Publisher","archived":false,"fork":false,"pushed_at":"2024-10-01T06:06:35.000Z","size":108,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-24T21:12:07.307Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/runnerty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-13T18:41:25.000Z","updated_at":"2021-04-30T01:26:48.000Z","dependencies_parsed_at":"2022-08-13T21:40:45.387Z","dependency_job_id":null,"html_url":"https://github.com/runnerty/executor-mqtt","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-mqtt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-mqtt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-mqtt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/runnerty%2Fexecutor-mqtt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/runnerty","download_url":"https://codeload.github.com/runnerty/executor-mqtt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235497425,"owners_count":18999659,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T21:11:51.892Z","updated_at":"2025-10-06T05:30:35.268Z","avatar_url":"https://github.com/runnerty.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://runnerty.io\"\u003e\n    \u003cimg height=\"257\" src=\"https://runnerty.io/assets/header/logo-stroked.png\"\u003e\n  \u003c/a\u003e\n  \u003cp align=\"center\"\u003eSmart Processes Management\u003c/p\u003e\n\u003c/p\u003e\n\n[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]\n\u003ca href=\"#badge\"\u003e\n\u003cimg alt=\"code style: prettier\" src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\u003e\n\u003c/a\u003e\n\n# Executor for [Runnerty]: MQTT\n\nModule MQTT Publisher.\nThis is a wrapper from the [MQTT.js](https://github.com/mqttjs/MQTT.js)\n\n### Installation:\n\nThrough NPM\n\n```bash\nnpm i @runnerty/executor-mqtt\n```\n\nYou can also add modules to your project with [runnerty-cli]\n\n```bash\nnpx runnerty-cli add @runnerty/executor-mqtt\n```\n\nThis command installs the module in your project, adds example configuration in your `config.json` and creates an example plan of use.\n\nIf you have installed [runnerty-cli] globally you can include the module with this command:\n\n```bash\nrty add @runnerty/executor-mqtt\n```\n\n### Configuration:\n\nAdd in [config.json]:\n\n##### Simple:\n\n```json\n{\n  \"id\": \"mqtt_default\",\n  \"type\": \"@runnerty-executor-mqtt\",\n  \"hostname\": \"localhost\"\n}\n```\n\n##### All parameters:\n\n```json\n{\n  \"id\": \"mqtt_default\",\n  \"type\": \"@runnerty-executor-mqtt\",\n  \"protocol\": \"mqtt\",\n  \"hostname\": \"localhost\",\n  \"port\": 1883,\n  \"username\": \"guest\",\n  \"password\": \"pass\",\n  \"keepalive\": 60,\n  \"reschedulePings\": true,\n  \"clientId\": \"mqttjs_@RANDOM(0, 1024, 1024)\",\n  \"protocolId\": \"MQTT\",\n  \"protocolVersion\": 4,\n  \"clean\": true,\n  \"reconnectPeriod\": 1000,\n  \"connectTimeout\": 30000,\n  \"queueQoSZero\": true,\n  \"tlsKeyFile\": \"./my_cert.key\",\n  \"tlsCertFile\": \"./my_cert.cert\",\n  \"tlsCAFile\": \"./my_cert.ca\",\n  \"rejectUnauthorized\": false,\n  \"properties\": {\n    \"sessionExpiryInterval\": 3600,\n    \"receiveMaximum\": 1024,\n    \"maximumPacketSize\": 32,\n    \"topicAliasMaximum\": 32,\n    \"requestResponseInformation\": true,\n    \"userProperties\": {\n      \"some\": \"value\"\n    },\n    \"authenticationMethod\": \"auth_method\",\n    \"authPacket\": {\n      \"some\": \"value\"\n    },\n    \"resubscribe\": true\n  }\n}\n```\n\n### Plan sample:\n\nAdd in [plan.json]:\n\n##### Simple:\n\n```json\n{\n  \"id\": \"mqtt_default\",\n  \"topic\": \"MY_TOPIC\",\n  \"message\": \"My message from Runnerty!\"\n}\n```\n\n##### All parameters:\n\n```json\n{\n  \"id\": \"mqtt_default\",\n  \"topic\": \"MY_TOPIC\",\n  \"message\": \"My message from Runnerty!\",\n  \"options\": {\n    \"qos\": 0,\n    \"retain\": false,\n    \"dup\": false,\n    \"properties\": {\n      \"payloadFormatIndicator\": true,\n      \"messageExpiryInterval\": 60,\n      \"topicAlias\": 1,\n      \"responseTopic\": \"res_topic\",\n      \"userProperties\": {\n        \"some\": \"value\"\n      },\n      \"subscriptionIdentifier\": 1234,\n      \"contentType\": \"contenttype_value\"\n    }\n  }\n}\n```\n\nMore information in MQTT [api reference](https://github.com/mqttjs/MQTT.js/#api)\n\n### Output (Process values):\n\n- `PROCESS_EXEC_ERR_OUTPUT`: Error output message.\n\n[runnerty]: http://www.runnerty.io\n[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-mqtt.svg\n[npm-url]: https://www.npmjs.com/package/@runnerty/executor-mqtt\n[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-mqtt.svg\n[david-badge]: https://david-dm.org/runnerty/executor-mqtt.svg\n[david-badge-url]: https://david-dm.org/runnerty/executor-mqtt\n[config.json]: http://docs.runnerty.io/config/\n[plan.json]: http://docs.runnerty.io/plan/\n[runnerty-cli]: https://www.npmjs.com/package/runnerty-cli\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-mqtt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frunnerty%2Fexecutor-mqtt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frunnerty%2Fexecutor-mqtt/lists"}