[{"_1":2,"_151":-5,"_152":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_130":131},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_82":-5,"_83":84,"_123":-5,"_124":11,"_125":17,"_126":11,"_127":-5,"_128":129},"canonicalUrl","https://hub.docker.com/r/berryk/mqtt-scripts/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","berryk","reponame","mqtt-scripts","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":30,"_43":11,"_44":45,"_46":47,"_48":49,"_51":30,"_27":28,"_52":53,"_54":39,"_55":56,"_57":58,"_59":60,"_61":-5,"_62":56,"_63":64,"_65":11,"_66":28,"_67":68,"_73":17,"_74":75,"_79":28,"_80":81},"categories",[],"content_types",[39],"image","date_registered","2018-02-18T22:19:33.827046Z","description","is_private","last_updated","2018-02-18T22:41:13.936639Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[50],"application/vnd.docker.container.image.v1+json","name","pull_count",853,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# mqtt-scripts\n\n[![mqtt-smarthome](https://img.shields.io/badge/mqtt-smarthome-blue.svg)](https://github.com/mqtt-smarthome/mqtt-smarthome)\n[![NPM version](https://badge.fury.io/js/mqtt-scripts.svg)](http://badge.fury.io/js/mqtt-scripts)\n[![Dependency Status](https://img.shields.io/gemnasium/hobbyquaker/mqtt-scripts.svg?maxAge=2592000)](https://gemnasium.com/github.com/hobbyquaker/mqtt-scripts)\n[![Build Status](https://travis-ci.org/hobbyquaker/mqtt-scripts.svg?branch=master)](https://travis-ci.org/hobbyquaker/mqtt-scripts)\n[![Coverage Status](https://coveralls.io/repos/github/hobbyquaker/mqtt-scripts/badge.svg?branch=master)](https://coveralls.io/github/hobbyquaker/mqtt-scripts?branch=master)\n[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\n[![License][mit-badge]][mit-url]\n\n> mqtt-scripts is a Node.js based script runner for use in mqtt based smart home environments. \n\nIt's intentended to be used as the \"logic layer\" in your smart home, and offers a zero-boilerplate, straight forward \nscripting environment.\n\nIt follows the [mqtt-smarthome](https://github.com/mqtt-smarthome/mqtt-smarthome) architecture. Mqtt-scripts could be \nseen as something like \"Node-RED without GUI\"\n\n\n# Getting started\n\nPrerequisites: mqtt-scripts needs Node.js >= 6.0.\n\n* Install mqtt-scripts globally:\n\n```sudo npm install -g mqtt-scripts```\n\n* Create a folder from where mqtt-scripts will load the scripts:\n\n```mkdir -p /opt/mqtt-smarthome/scripts```\n\n* Create a folder to install node modules that can be used in the scripts:\n\n```mkdir /opt/mqtt-smarthome/scripts/node_modules``` \n(You can then just use npm install in the directory /opt/mqtt-smarthome/scripts)\n\n* Put some files in you script dir:\n\n```\necho \"log.info('my first script!')\" > /opt/mqtt-smarthome/scripts/test1.js\necho \"log.info 'get ma a coffee' > /opt/mqtt-smarthome/scripts/test1.coffee\n``` \n\n* Start mqtt-scripts\n\n```mqtt-scripts -d /opt/mqtt-smarthome/scripts``` \n\n\n# Command Line Options\n\n

\nUsage: mqtt-scripts [options]\n\nOptions:\n  -v, --verbosity          possible values: \"error\", \"warn\", \"info\", \"debug\"\n                                                               [default: \"info\"]\n  -n, --name               instance name. used as mqtt client id and as prefix\n                           for connected topic                [default: \"logic\"]\n  -s, --variable-prefix    topic prefix for $ substitution (shorthand for\n                           variables, see docs)                 [default: \"var\"]\n  -t, --disable-variables  disable variable feedback (see docs)\n                                                                [default: false]\n  -u, --url                mqtt broker url. See https://github.com/mqttjs/MQTT.\n                           js#connect-using-a-url  [default: \"mqtt://127.0.0.1\"]\n  -h, --help               Show help                                  \n  -d, --dir                directory to scan for .js and .coffee files. can be\n                           used multiple times.\n  -w, --disable-watch      disable file watching (don't exit process on file\n                           changes)                             \n  --version                Show version number                        \n  -l, --latitude           Coordinates are needed for the sunSchedule method                                  \n  -m, --longitude                                             \n

\n\nIf you're running multiple instances of mqtt-scripts you have to decide which one should handle variables and disable \nthe variables on all other instances with the --disable-variable option.\n\n\n# Script Examples\n\n#### Use hm2mqtt and hue2mqtt to control a hue lamp with a homematic remote control\n\n```javascript\nlink('hm//RC4:1/PRESS_CONT', 'hue//lights/Hobbyraum/bri_inc', -16);\n\nsubscribe('hm//RC4:2/PRESS_CONT', function () {\n if (!getValue('hue//lights/Hobbyraum')) {\n setValue('hue//lights/Hobbyraum', 1);\n } else {\n setValue('hue//lights/Hobbyraum/bri_inc', 16);\n }\n});\n\nlink('hm//RC4:1/PRESS_SHORT', 'hue//lights/Hobbyraum', 0);\nlink('hm//RC4:2/PRESS_SHORT', 'hue//lights/Hobbyraum', 254);\nlink('hm//RC4:3/PRESS_CONT', 'hue//lights/Hobbyraum/ct_inc', -16);\nlink('hm//RC4:4/PRESS_CONT', 'hue//lights/Hobbyraum/ct_inc', 16);\nlink('hm//RC4:3/PRESS_SHORT', 'hue//lights/Hobbyraum/ct', 153);\nlink('hm//RC4:4/PRESS_SHORT', 'hue//lights/Hobbyraum/ct', 500);\n```\n\n#### retrieve fuel prices from tankerkoenig\n\n```javascript\nvar request = require('request');\nvar cred = require('./lib/credentials.js');\n\nvar url = 'https://creativecommons.tankerkoenig.de/json/detail.php';\n\nvar tankstellen = {\n 'OMV': 'cb1f0588-d517-40f0-8ce3-3edadebea40d',\n 'Shell': '4267c196-eea1-47be-96b7-d790b2fbd17a'\n};\n\nschedule('0/12 * * * *', function () {\n for (var topic in tankstellen) {\n getData(topic, tankstellen[topic]);\n }\n});\n\nfunction getData(topic, id) {\n request.get(url + '?id=' + id + '&apikey=' + cred.tankerkoenig.apikey, function (err, res) {\n if (err) {\n log.error(err);\n return;\n }\n var data = JSON.parse(res.body).station;\n setValue('$Tankstelle/' + topic + '/Diesel', data.diesel);\n setValue('$Tankstelle/' + topic + '/E5', data.e5);\n setValue('$Tankstelle/' + topic + '/Offen', data.isOpen);\n });\n}\n```\n\n#### Send a variables state changes to Pushover\n\n```Javascript\nvar cred = require('./lib/credentials.js');\n\nvar pushoverNotifications = require('pushover-notifications');\n\nvar push = new pushoverNotifications( {\n user: cred.pushover.user,\n token: cred.pushover.token,\n onerror: function (error) {\n log.error(error);\n }\n});\n\nfunction pushover(msg) {\n if (typeof msg !== 'object' || typeof msg.message !== 'string') msg = {message: '' + msg};\n msg.title = msg.title || \"Smart Home\";\n msg.priority = msg.priority || 0;\n msg.device = msg.device || 'iphone5';\n push.send(msg, function(err, result) {\n if (err) {\n log.error(err);\n }\n });\n}\n\nsubscribe('$Anwesenheit', {change: true}, function () {\n pushover({\n title:'Anwesenheit',\n message: getProp($Anwesenheit, 'logic_textual'),\n priority: -1\n });\n});\n```\n\n# API\n\n## Classes\n\n

log: Log to stdout/stderr. Messages are prefixed with a timestamp and the calling scripts path.
\n

\n\n## Functions\n\n

subscribe(topic, [options], callback): Subscribe to MQTT topic(s)
\n
schedule(pattern, [options], callback): Schedule recurring and one-shot events
\n
sunSchedule(pattern, [options], callback): Schedule a recurring event based on sun position
\n
publish(topic, payload, [options]): Publish a MQTT message
\n
setValue(topic, val): Set a value on one or more topics
\n
getValue(topic) ⇒ mixed
link(source, target, [value]): Link topic(s) to other topic(s)
\n
getProp(topic, [...property]) ⇒ mixed: Get a specific property of a topic
\n
now() ⇒ number
age(topic) ⇒ number

\n\n## Typedefs\n\n

subscribeCallback : function

\n\n\n\n## log\nLog to stdout/stderr. Messages are prefixed with a timestamp and the calling scripts path.\n\n**Kind**: global class \n\n* [log](#log)\n * [.debug()](#log.debug)\n * [.info()](#log.info)\n * [.warn()](#log.warn)\n * [.error()](#log.error)\n\n\n\n### log.debug()\nLog a debug message\n\n**Kind**: static method of [log](#log) \n\n| Type |\n| --- |\n| \\* | \n\n\n\n### log.info()\nLog an info message\n\n**Kind**: static method of [log](#log) \n\n| Type |\n| --- |\n| \\* | \n\n\n\n### log.warn()\nLog a warning message\n\n**Kind**: static method of [log](#log) \n\n| Type |\n| --- |\n| \\* | \n\n\n\n### log.error()\nLog an error message\n\n**Kind**: static method of [log](#log) \n\n| Type |\n| --- |\n| \\* | \n\n\n\n## subscribe(topic, [options], callback)\nSubscribe to MQTT topic(s)\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| topic | string \\| Array.<string> | topic or array of topics to subscribe |\n| [options] | Object \\| string \\| function | Options object or as shorthand to options.condition a function or string |\n| [options.shift] | number | delay execution in seconds. Has to be positive |\n| [options.random] | number | random delay execution in seconds. Has to be positive |\n| [options.change] | boolean | if set to true callback is only called if val changed |\n| [options.retain] | boolean | if set to true callback is also called on retained messages |\n| [options.condition] | string \\| function | conditional function or condition string |\n| callback | [subscribeCallback](#subscribeCallback) | |\n\n\n\n## schedule(pattern, [options], callback)\nSchedule recurring and one-shot events\n\n**Kind**: global function \n**See**: [sunSchedule](#sunSchedule) for scheduling based on sun position. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| pattern | string \\| Date \\| Object \\| Array.<mixed> | pattern or array of patterns. May be cron style string, Date object or node-schedule object literal. See [https://github.com/tejasmanohar/node-schedule/wiki](https://github.com/tejasmanohar/node-schedule/wiki) |\n| [options] | Object | |\n| [options.random] | number | random delay execution in seconds. Has to be positive |\n| callback | function | is called with no arguments |\n\n**Example** \n```js\n// every full Hour.\nschedule('0 * * * *', callback);\n\n// Monday till friday, random between 7:30am an 8:00am\nschedule('30 7 * * 1-5', {random: 30 * 60}, callback);\n\n// once on 21. December 2018 at 5:30am\nschedule(new Date(2018, 12, 21, 5, 30, 0), callback);\n\n// every Sunday at 2:30pm\nschedule({hour: 14, minute: 30, dayOfWeek: 0}, callback);\n```\n\n\n## sunSchedule(pattern, [options], callback)\nSchedule a recurring event based on sun position\n\n**Kind**: global function \n**See**: [schedule](#schedule) for time based scheduling. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| pattern | string \\| Array.<string> | a suncalc event or an array of suncalc events. See [https://github.com/mourner/suncalc](https://github.com/mourner/suncalc) |\n| [options] | Object | |\n| [options.shift] | number | delay execution in seconds. Allowed Range: -86400...86400 (+/- 24h) |\n| [options.random] | number | random delay execution in seconds. |\n| callback | function | is called with no arguments |\n\n**Example** \n```js\n// Call callback 15 minutes before sunrise\nsunSchedule('sunrise', {shift: -900}, callback);\n\n// Call callback random 0-15 minutes after sunset\nsunSchedule('sunset', {random: 900}, callback);\n```\n\n\n## publish(topic, payload, [options])\nPublish a MQTT message\n\n**Kind**: global function \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| topic | string \\| Array.<string> | | topic or array of topics to publish to |\n| payload | string \\| Object | | the payload string. If an object is given it will be JSON.stringified |\n| [options] | Object | | the options to publish with |\n| [options.qos] | number | 0 | QoS Level |\n| [options.retain] | boolean | false | retain flag |\n\n\n\n## setValue(topic, val)\nSet a value on one or more topics\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| topic | string \\| Array.<string> | topic or array of topics to set value on |\n| val | mixed | |\n\n\n\n## getValue(topic) ⇒ mixed\n**Kind**: global function \n**Returns**: mixed - the topics value \n\n| Param | Type |\n| --- | --- |\n| topic | string | \n\n\n\n## link(source, target, [value])\nLink topic(s) to other topic(s)\n\n**Kind**: global function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| source | string \\| Array.<string> | topic or array of topics to subscribe |\n| target | string \\| Array.<string> | topic or array of topics to publish |\n| [value] | mixed | value to publish. If omitted the sources value is published. |\n\n\n\n## getProp(topic, [...property]) ⇒ mixed\nGet a specific property of a topic\n\n**Kind**: global function \n**Returns**: mixed - the topics properties value \n\n| Param | Type | Description |\n| --- | --- | --- |\n| topic | string | |\n| [...property] | string | the property to retrieve. May be repeated for nested properties. If omitted the whole topic object is returned. |\n\n**Example** \n```js\n// returns the timestamp of a given topic\ngetProp('hm//Bewegungsmelder Keller/MOTION', 'ts');\n```\n\n\n## now() ⇒ number\n**Kind**: global function \n**Returns**: number - ms since epoch \n\n\n## age(topic) ⇒ number\n**Kind**: global function \n**Returns**: number - seconds since last change \n\n| Param | Type |\n| --- | --- |\n| topic | string | \n\n\n\n## subscribeCallback : function\n**Kind**: global typedef \n\n| Param | Type | Description |\n| --- | --- | --- |\n| topic | string | the topic that triggered this callback. +/status/# will be replaced by +//# |\n| val | mixed | the val property of the new state |\n| obj | object | new state - the whole state object (e.g. {\"val\": true, \"ts\": 12346345, \"lc\": 12346345} ) |\n| objPrev | object | previous state - the whole state object |\n| msg | object | the mqtt message as received from MQTT.js |\n\n\n# License\n\n\nMIT © [Sebastian Raff](https://github.com/hobbyquaker)\n\n[mit-badge]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat\n[mit-url]: LICENSE\n","has_starred","hub_user","immutable_tags_settings",{"_69":11,"_70":71},"enabled","rules",[72],".*","is_automated","permissions",{"_76":17,"_77":11,"_78":11},"read","write","admin","user","storage_size",539745369,"orgData","recentTags",[85],{"_86":39,"_87":88,"_89":90,"_91":92,"_93":94,"_44":112,"_113":88,"_114":28,"_115":50,"_51":116,"_117":118,"_119":103,"_120":112,"_121":60,"_122":17},"content_type","creator",2037024,"full_size",273574872,"id",22469387,"images",[95],{"_96":97,"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":101,"_109":-5,"_110":90,"_57":60,"_111":-5},"architecture","amd64","digest","sha256:bef1c2a0c48799bfee60b055049df45ff920528e68744ef8892f4f9b3b8b162e","features","","last_pulled","2026-09-15T11:55:00.842777758Z","last_pushed","2018-02-18T22:41:14Z","os","linux","os_features","os_version","size","variant","2018-02-18T22:41:13.594Z","last_updater","last_updater_username","media_type","latest","repository",4159564,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":132,"_139":140,"_128":149,"_150":11},{"_35":133,"_37":134,"_40":41,"_42":30,"_43":11,"_44":45,"_46":47,"_48":135,"_51":30,"_27":28,"_52":53,"_54":39,"_55":56,"_57":58,"_59":60,"_61":-5,"_62":56,"_63":64,"_65":11,"_66":28,"_67":136,"_73":17,"_74":138,"_79":28,"_80":81},[],[39],[50],{"_69":11,"_70":137},[72],{"_76":17,"_77":11,"_78":11},"tags",{"_141":58,"_142":-5,"_143":-5,"_144":145},"count","next","previous","results",[146],{"_86":39,"_87":88,"_89":90,"_91":92,"_93":147,"_44":112,"_113":88,"_114":28,"_115":50,"_51":116,"_117":118,"_119":103,"_120":112,"_121":60,"_122":17},[148],{"_96":97,"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":101,"_109":-5,"_110":90,"_57":60,"_111":-5},[],"canDeleteTags","actionData","errors"]

berryk/mqtt-scripts

Tags for berryk/mqtt-scripts