node-red-contrib-huemagic 2.8.2 → 4.0.0

package/huemagic/locales/en-US/hue-bridge.html

@@ -1,174 +1,93 @@
-<script type="text/x-red" data-help-name="hue-bridge-node">
-    <p>Hue Bridge node keeps the Hue Bridge firmware and connected devices up-to-date and provides more information and setup options for the bridge.</p>
+<script type="text/markdown" data-help-name="hue-bridge-node">
+The "Hue Bridge" node is a universal node that can output all settings of the bridge and status messages from other nodes.
 
-    <h3>Setup</h3>
-    <p>Select the preconfigured Hue Bridge and choose if the selected bridge should automatically find and install firmware and other device updates. If you activate the "Skip global events" option, this node will not send messages from updated and active devices and other ressources.</p>
+### Setup
 
-    <h3>Get settings / status</h3>
-    <p>Retrieves the current status / settings of the bridge by injecting any input value</p>
-    <dl class="message-properties">
-        <dt>true<span class="property-type">boolean (example)</span></dt>
-        <dd>Triggers an output of the current status / settings</dd>
-    </dl>
+First select the desired Hue Bridge. You can optionally deactivate all automatic status messages for this node by clicking the setting “Skip global device updates / messages on this node”. The node will then no longer issue device updates.
 
-    <h3>Enable TouchLink scan</h3>
-    <p>Use TouchLink to pair new devices or old devices after a bridge reset. This is commonly known in the community as "Lamp stealer". Pass the <b>touchLink</b> property to <b>msg.payload</b>.</p>
-    <dl class="message-properties">
-        <dt>touchLink<span class="property-type">boolean (example)</span></dt>
-        <dd>Pairs lights / devices</dd>
-    </dl>
+Alternatively, you can also choose whether the initialization messages of all nodes should not be suppressed when Node-RED is started. If you activate this setting, you will receive a status message from all resources connected to the bridge after each deployment.
 
-    <h3>Fetch all devices and resources</h3>
-    <p>Use the Fetch command to retrieve various information from the Hue Bridge when needed. Pass the <b>fetch</b> property to <b>msg.payload</b>.</p>
-    <dl class="message-properties">
-        <dt>users<span class="property-type">string</span></dt>
-        <dd>Returns an array of User objects in msg.users & bridge information in msg.info</dd>
+### Get settings / status
 
-        <dt>lights<span class="property-type">string</span></dt>
-        <dd>Returns an array of Light objects in msg.lights & bridge information in msg.info</dd>
+Outputs the current status / settings of the bridge as soon as the following message has been sent to the node. Alternatively, you can also press the button in the Node-RED interface without having to pass a message to the node beforehand.
 
-        <dt>groups<span class="property-type">string</span></dt>
-        <dd>Returns an array of Group objects in msg.groups & bridge information in msg.info</dd>
+: payload (boolean): Returns the current status of the bridge
 
-        <dt>sensors<span class="property-type">string</span></dt>
-        <dd>Returns an array of Sensor objects in msg.sensors & bridge information in msg.info</dd>
+### Trigger TouchLink scan
 
-        <dt>scenes<span class="property-type">string</span></dt>
-        <dd>Returns an array of Scene objects in msg.scenes & bridge information in msg.info</dd>
+You can couple new or old devices to the bridge using a "TouchLink scan" (e.g. after a reset). To do this, transfer the object `msg.payload` with the following content:
 
-        <dt>rules<span class="property-type">string</span></dt>
-        <dd>Returns an array of Rule objects in msg.rules & bridge information in msg.info</dd>
+: touchLink (boolean): Couples old or new devices with the bridge
 
-        <dt>schedules<span class="property-type">string</span></dt>
-        <dd>Returns an array of Schedule objects in msg.schedules & bridge information in msg.info</dd>
+### Get all devices and resources
 
-        <dt>resourceLinks<span class="property-type">string</span></dt>
-        <dd>Returns an array of ResourceLink objects in msg.resourceLinks & bridge information in msg.info</dd>
+With the "fetch" command you can output a list of specific devices that are currently connected to the bridge. To do this, transfer the object `msg.payload` with the following content:
 
-        <dt>timeZones<span class="property-type">string</span></dt>
-        <dd>Returns an array of all available time zones in msg.timeZones & bridge information in msg.info</dd>
+: fetch (string | array [string, ...]): Can accept `light`, `group`, `button`, `motion`, `temperature`, `light_level` or `rule` as value(s)
 
-        <dt>internetServices<span class="property-type">string</span></dt>
-        <dd>Returns an object of all available internet services information in msg.internetServices & bridge information in msg.info</dd>
+### Change Hue Bridge settings
 
-        <dt>portal<span class="property-type">string</span></dt>
-        <dd>Returns an object of all available portal information in msg.portal & bridge information in msg.info</dd>
-    </dl>
+You can use the following command to change specific settings on the bridge. Please note that changing the network settings requires reconfiguring the bridge on HueMagic. Transfer the object `msg.payload.settings` with the following setting options to the node:
 
-    <h3>Hue Bridge Settings</h3>
-    <p>Changes the Hue Bridge settings based on the passed in <b>msg.payload.settings</b> values of:</p>
-    <dl class="message-properties">
-        <dt>name<span class="property-type">string</span></dt>
-        <dd>Name of the bridge</dd>
+: name (string): Changes the name of the bridge and must contain at least 4 to a maximum of 16 characters
+: zigbeeChannel (int): Changes the current ZigBee channel (either `11`, `15`, `20`, `25` or `0`)
+: ipAddress (string): Changes the IP address in the network settings
+: dhcpEnabled (boolean): `true`, activates DHCP in the network settings, `false`, deactivates the setting
+: netmask (string): Changes the network mask in the network settings
+: gateway (string): Specifies the gateway in the network settings
+: proxyAddress (string): Sets a proxy address in the network settings
+: proxyPort (string | int): Specifies the port of the proxy in the network settings
+: timeZone (string): Changes the currently set time zone on the bridge
 
-        <dt>zigbeeChannel<span class="property-type">int</span></dt>
-        <dd>ZigBee channel (for communicating with lights)</dd>
+### Status messages from the node
 
-        <dt>ipAddress<span class="property-type">string</span></dt>
-        <dd>IP address (risky)</dd>
+The status reports of the "Hue Bridge" node are dynamic. Although they follow a certain pattern, their output can vary depending on what action has just been carried out on the node.
 
-        <dt>dhcpEnabled<span class="property-type">boolean</span></dt>
-        <dd>Whether or not DHCP is enabled</dd>
+#### Status object under `msg.payload`
 
-        <dt>netmask<span class="property-type">string</span></dt>
-        <dd>Netmask (risky)</dd>
+: id (string): Unique ID of the Hue Bridge
+: name (string): Currently set name
+: factoryNew (boolean): Indicator whether the bridge is brand new
+: replacesBridgeId (string | boolean): Outputs the old bridge ID (if a migration was carried out) or outputs `false`
+: dataStoreVersion (string): Version of the data store
+: starterKitId (string | boolean): Name of the starter kit created in the factory or `false`
+: softwareVersion (string): Software version of the bridge
+: apiVersion (string): API version of the bridge
+: zigbeeChannel (int): Currently used ZigBee channel
+: macAddress (string): MAC address of the bridge
+: ipAddress (string): IP address of the bridge
+: dhcpEnabled (boolean): Indicates whether DHCP is enabled
+: netmask (string): Netmask of the bridge
+: gateway (string): Gateway of the bridge
+: proxyAddress (string | false): Currently used proxy address or `false`
+: proxyPort (string): Currently used proxy port
+: utcTime (string): UTC time on the bridge
+: timeZone (string): Currently set time zone on the bridge
+: localTime (string): Local time zone
+: portalServicesEnabled (boolean): Indicates whether portal services are enabled
+: portalConnected (boolean): Indicates whether the bridge is connected to the portal
+: linkButtonEnabled (boolean): Indicates whether the link button is enabled
+: touchlinkEnabled (boolean): Indicates whether TouchLink is enabled
+: autoUpdatesEnabled (boolean): Indicates whether the HueMagic will automatically check for updates
+: users (array [object, ...]): List of all users on the bridge (array with objects)
+: updated (string): Time of the last update of the resource by HueMagic (ISO 8601)
+: model (object): Contains the model information of the bridge under `id`, `manufacturer` and `name`
 
-        <dt>gateway<span class="property-type">string</span></dt>
-        <dd>Gateway (risky)</dd>
+#### Fetch results under `msg.results` (optional)
 
-        <dt>proxyAddress<span class="property-type">string</span></dt>
-        <dd>Proxy address</dd>
+If the "fetch" command has been used on the node, the bridge outputs the corresponding results under the `msg.results` object. The object contains the queried resource groups, which in turn contain all the corresponding resources in the form of an array.
 
-        <dt>proxyPort<span class="property-type">string</span></dt>
-        <dd>Proxy port</dd>
+#### Global status messages under `msg.updated` (optional)
 
-        <dt>timeZone<span class="property-type">string</span></dt>
-        <dd>Time zone</dd>
-    </dl>
+Unless deactivated, the node issues an updated status message for each resource on the bridge. The status message under * msg.updated * follows the pattern of the respective resource and varies depending on the type of device that was last updated.
 
-    <h3>Hue Bridge Events</h3>
-    <p>The event message that the bridge sends contains the following data in the <b>msg.payload</b> object:</p>
-    <dl class="message-properties">
-        <dt>id<span class="property-type">string</span></dt>
-        <dd>Unique ID of the Hue Bridge</dd>
+#### Last command under `msg.command` (optional)
 
-        <dt>name<span class="property-type">string</span></dt>
-        <dd>Name of the bridge</dd>
+If the status of the node has changed via a certain command, the entire command that was executed is also output. Otherwise this object will not be output by the node.
 
-        <dt>factoryNew<span class="property-type">boolean</span></dt>
-        <dd>Whether or not the bridge is factory new</dd>
+### Examples from HueMagic
 
-        <dt>replacesBridgeId<span class="property-type">string / null</span></dt>
-        <dd>Replaces bridge id (for migrating from old bridges)</dd>
+HueMagic provides some sample configurations for this node. To import a full featured example into your Node-RED interface, click on the Node-RED menu icon, then select "Import" and navigate to "Examples" in the sidebar of the popup. Then select the HueMagic folder and your desired node to import a sample flow.
 
-        <dt>dataStoreVersion<span class="property-type">string</span></dt>
-        <dd>Data store version</dd>
-
-        <dt>starterKitId<span class="property-type">string</span></dt>
-        <dd>Name of the starterkit created in the factory</dd>
-
-        <dt>softwareVersion<span class="property-type">string</span></dt>
-        <dd>Software version of the bridge</dd>
-
-        <dt>apiVersion<span class="property-type">string</span></dt>
-        <dd>API version of the bridge</dd>
-
-        <dt>zigbeeChannel<span class="property-type">int</span></dt>
-        <dd>ZigBee channel (for communicating with lights)</dd>
-
-        <dt>macAddress<span class="property-type">string</span></dt>
-        <dd>MAC address</dd>
-
-        <dt>ipAddress<span class="property-type">string</span></dt>
-        <dd>IP address</dd>
-
-        <dt>dhcpEnabled<span class="property-type">boolean</span></dt>
-        <dd>Whether or not DHCP is enabled</dd>
-
-        <dt>netmask<span class="property-type">string</span></dt>
-        <dd>Netmask</dd>
-
-        <dt>gateway<span class="property-type">string</span></dt>
-        <dd>Gateway</dd>
-
-        <dt>proxyAddress<span class="property-type">string</span></dt>
-        <dd>Proxy address</dd>
-
-        <dt>proxyPort<span class="property-type">string</span></dt>
-        <dd>Proxy port</dd>
-
-        <dt>utcTime<span class="property-type">string</span></dt>
-        <dd>UTC time of the bridge</dd>
-
-        <dt>timeZone<span class="property-type">string</span></dt>
-        <dd>Time zone</dd>
-
-        <dt>localTime<span class="property-type">string</span></dt>
-        <dd>Local time of the bridge</dd>
-
-        <dt>portalServicesEnabled<span class="property-type">boolean</span></dt>
-        <dd>Whether or not portal services are enabled</dd>
-
-        <dt>portalConnected<span class="property-type">boolean</span></dt>
-        <dd>Whether or not portal is connected</dd>
-
-        <dt>linkButtonEnabled<span class="property-type">boolean</span></dt>
-        <dd>Whether or not link button is enabled</dd>
-
-        <dt>touchlinkEnabled<span class="property-type">boolean</span></dt>
-        <dd>Whether or not TouchLink is enabled</dd>
-
-        <dt>model<span class="property-type">object</span></dt>
-        <dd>The model object of the bridge includes model specific information like the model.id, model.manufacturer and model.name</dd>
-    </dl>
-
-    <h3>Global update events</h3>
-    <p>The bridge also sends events when a certain active resource (lights, groups, sensors, etc.) changes its status.</p>
-    <dl class="message-properties">
-        <dt>msg.updated<span class="property-type">object</span></dt>
-        <dd>The whole object of the device (check docs)</dd>
-
-        <dt>msg.type<span class="property-type">string</span></dt>
-        <dd>Can be one of the following: light, group, rule, motion, brightness, temperature, switch, tap</dd>
-    </dl>
+![examples](https://user-images.githubusercontent.com/5302050/148681840-2275c15a-7c0c-4a37-b817-199608e571d2.gif)
 </script>

package/huemagic/locales/en-US/hue-bridge.json

@@ -5,10 +5,8 @@
 		{
 			"name": "Name",
 			"input-name": "Hue Bridge name",
-			"autoupdates": "Auto updates",
-			"autoupdates-info": "Activate automatic firmware updates",
-			"skipglobalevents": "Skip global events",
-			"skipglobalevents-info": "Skip global device updates / messages on this node"
+			"skipglobalevents-info": "Skip global device updates / messages on this node",
+			"sendinitevents-node": "Do not suppress initialization event"
 		},
 		"node":
 		{
@@ -18,21 +16,12 @@
 			"connected": "connected",
 			"starting-tl": "starting TouchLink…",
 			"started-tl": "TouchLink started…",
-			"f-users": "fetching users…",
-			"f-lights": "fetching lights…",
-			"f-groups": "fetching groups…",
-			"f-sensors": "fetching sensors…",
-			"f-scenes": "fetching scenes…",
-			"f-rules": "fetching rules…",
-			"f-schedules": "fetching schedules…",
-			"f-rlinks": "fetching resource links…",
-			"f-timezones": "fetching timezones…",
-			"f-internet": "fetching Internet Services…",
-			"f-portal": "fetching Portal…",
+			"f-ressources": "fetching ressources…",
 			"updating-settings": "updating settings…",
 			"settings-updated": "settings updated",
 			"input": "settings / fetch",
-			"output": "bridge information"
+			"output": "bridge information",
+			"statusmsg": "Status queried successfully…"
 		}
 	}
 }

package/huemagic/locales/en-US/hue-brightness.html

@@ -1,53 +1,67 @@
-<script type="text/x-red" data-help-name="hue-brightness">
-    <p>Hue brightness node to receive current light level in Lux and daylight / darkness.</p>
+<script type="text/markdown" data-help-name="hue-brightness">
+The "Hue Brightness" node can read the current light level from a suitable sensor on the bridge.
 
-    <h3>Setup</h3>
-    <p>Select the preconfigured Hue Bridge and hit the search button to find all available Lux sensors. Type in the name of the sensor manually or keep the default device name. Note that events will only be sent on deploy (once) and if the light level changes. If necessary, all status updates of this node can be ignored by activating the "Skip events" option.</p>
+### Setup
 
-    <h3>Light Level Events</h3>
-    <p>The event message that the light sensor sends contains the following data in the <b>msg.payload</b> object:</p>
-    <dl class="message-properties">
-        <dt>lux<span class="property-type">int</span></dt>
-        <dd>Real lux value</dd>
+Select the pre-configured Hue Bridge and click the search button to find all the available sensors. If you already know the ID of the sensor, you can also enter it here manually. You can either assign a new name for the sensor internally or choose the predefined name of the sensor. Optionally, you can also deactivate all automatic status messages for this node by clicking the setting "Skip events from node". The node will then no longer issue device updates. Alternatively, you can also choose whether the node's initialization message should not be suppressed when Node-RED is started. If you activate this setting, you will receive a status message for the currently selected sensor after each deployment.
 
-        <dt>lightLevel<span class="property-type">int</span></dt>
-        <dd>Light level</dd>
+If you do not select a sensor and use the node configuration in this way, the node works in the so-called "universal mode". In this mode, the node receives and outputs all status messages of the same type. You can also apply settings in universal mode to a specific sensor by transferring the corresponding sensor ID as a string in `msg.topic` together with your settings.
 
-        <dt>dark<span class="property-type">boolean</span></dt>
-        <dd>True if it's dark</dd>
+### Get status
 
-        <dt>daylight<span class="property-type">boolean</span></dt>
-        <dd>True if daylight recognized</dd>
+Outputs the current status of the sensor as soon as a `msg.payload` object with the following content has been transferred to the node. Alternatively, you can also press the button in the Node-RED interface without having to pass a message to the node beforehand.
 
-        <dt>updated<span class="property-type">string</span></dt>
-        <dd>ISO 8601 date string of the last light level update</dd>
-    </dl>
+: status (boolean): Returns the current status of the sensor
 
-    <h3>Additional Sensor Info</h3>
-    <p>Additional information about the sensor is going to be sent to the <b>msg.info</b> object:</p>
-    <dl class="message-properties">
-        <dt>id<span class="property-type">int</span></dt>
-        <dd>Numerical id of the sensor as registered on the bridge</dd>
+### Turn the sensor on / off
 
-        <dt>uniqueId<span class="property-type">string</span></dt>
-        <dd>Unique Id of the sensor (typically hardware id)</dd>
+If necessary, the sensor can be turned on and off remotely. If the sensor has been turned off, it no longer registers any changes in light level and accordingly no longer outputs them. To do this, pass an object with the following content:
 
-        <dt>name<span class="property-type">string</span></dt>
-        <dd>Name for the sensor</dd>
+: payload (boolean): `true` switches the sensor on, `false` switches it off
 
-        <dt>type<span class="property-type">string</span></dt>
-        <dd>Sensor type (e.g. Daylight, CLIPTemperature, ZGPSwitch)</dd>
+### Status messages from the node
 
-        <dt>softwareVersion<span class="property-type">float</span></dt>
-        <dd>Software version of the sensor</dd>
+As soon as the sensor has detected a change in the light level, the following status message is returned:
 
-        <dt>battery<span class="property-type">int</span></dt>
-        <dd>Current battery level of the sensor in percent</dd>
+#### Status object under `msg.payload`
 
-        <dt>model<span class="property-type">object</span></dt>
-        <dd>The model object of the sensor includes model specific information like the model.id, model.manufacturer, model.name and model.type</dd>
-    </dl>
+: active (boolean): Indicates whether the sensor is turned on or off
+: reachable (boolean | string): `true` if the sensor is connected to the bridge, `unknown` if the connection status deviates
+: connectionStatus (string): The current connection status with the bridge in the form of a string. Can contain `connected`,` disconnected`, `connectivity_issue` or `unidirectional_incoming` as a value
+: lux (int): Indicates the real LUX value of the light level
+: lightLevel (int): Indicates the light intensity of the sensor
+: dark (boolean): `true`, if darkness was registered
+: daylight (boolean): `true`, if daylight was registered
+: updated (string): Time of the last update of the resource by HueMagic (ISO 8601)
 
-    <h3>Last State Information</h3>
-    <p>This node also sends the entire last state data (before the update) in the <b>msg.lastState</b> object. It can either contain false (boolean) or the objects payload (msg.lastState.payload) and info (msg.lastState.info). The return value "false" is only sent if there was no last state, e.g. when the node was newly created or restarted.</p>
+#### Information about the sensor under `msg.info`
+
+: id (string): Indicates the new ID of the sensor
+: idV1 (string | boolean): Indicates the old ID of the sensor
+: uniqueId (string): The unique ID of the sensor
+: deviceId (string): The unique ID of the device
+: name (string): The currently set name of the sensor
+: type (string): The type of the sensor (always `light_level`)
+: softwareVersion (string): The current firmware of the sensor
+: battery (float): The current battery level of the sensor
+: batteryState (string): The current status of the battery level. Can contain `normal`, `low` or `critical` as a value
+: model (object): Contains the model information of the sensor under `id`, `manufacturer`, `name`, `type` and `certified`
+
+#### Status changes under `msg.updated`
+
+Lists individual parameters in the form of an object that have changed compared to the last state of the sensor. If no changes have been registered, this object is empty.
+
+#### Last status of the sensor under `msg.lastState`
+
+Contains the complete status object (see output values above) of the last status before the last registered change. If the last state of HueMagic has not yet been registered, it will output `false`.
+
+#### Last command under `msg.command` (optional)
+
+If the status of the node has changed via a certain command, the entire command that was executed is also output. Otherwise this object will not be output by the node.
+
+### Examples from HueMagic
+
+HueMagic provides some sample configurations for this node. To import a full featured example into your Node-RED interface, click on the Node-RED menu icon, then select "Import" and navigate to "Examples" in the sidebar of the popup. Then select the HueMagic folder and your desired node to import a sample flow.
+
+![examples](https://user-images.githubusercontent.com/5302050/148681840-2275c15a-7c0c-4a37-b817-199608e571d2.gif)
 </script>

package/huemagic/locales/en-US/hue-brightness.json

@@ -5,24 +5,31 @@
 		{
 			"name": "Name",
 			"input-name": "Brightness sensor name",
-			"skipevents": "Skip events",
 			"skipevents-node": "Skip events from node",
+			"sendinitevents-node": "Do not suppress initialization event",
 			"searching": "Searching sensors…",
 			"none-found": "No brightness sensors found!",
 			"unknown-error": "Something went wrong. Please retry.",
 			"sensor": "Sensor",
-			"all": "All groups / lights"
+			"all": "All groups / lights",
+			"universalevents": "Universal Events",
+			"universalevents-node": "Receives all messages from other nodes of the same type (only in universal mode)"
 		},
 		"node":
 		{
 			"title": "Hue Brightness",
 			"not-configured": "not configured",
+			"deactivated": "deactivated",
 			"init": "initializing…",
 			"not-reachable": "not reachable",
 			"lux": "__lux__ Lux",
 			"lux-dark": "__lux__ Lux (dark)",
 			"lux-daylight": "__lux__ Lux (daylight)",
-			"output": "brightness (changed)"
+			"input": "status query",
+			"output": "brightness (changed)",
+			"universal": "universal mode",
+			"command": "executing command…",
+			"statusmsg": "Status queried successfully…"
 		}
 	}
 }

package/huemagic/locales/en-US/hue-buttons.html

@@ -0,0 +1,58 @@
+<script type="text/markdown" data-help-name="hue-buttons">
+The "Hue Buttons" node receives switching events from input devices connected to the bridge.
+
+### Setup
+
+Select the pre-configured Hue Bridge and hit the search button to find all the available switches/buttons. If you already know the ID of the switch, you can also enter it here manually. You can either assign a new name for the switch internally or keep the predefined name of the device. Optionally, you can also deactivate all automatic status messages for this node by clicking the setting "Skip events from node". The node will then no longer output any switching events. Alternatively, you can also choose whether the node's initialization message should not be suppressed when Node-RED is started. If you activate this setting, you will receive a status message for the currently selected switch after each deployment.
+
+If you do not select a switch/button and use the node configuration in this way, the node works in the so-called "universal mode". In this mode, the node receives and outputs all status messages of the same type.
+
+### Get status
+
+Outputs the current status of the switch/button as soon as a `msg.payload` object with the following content has been passed to the node. Alternatively, you can also press the button in the Node-RED interface without having to pass a message to the node beforehand.
+
+: status (boolean): Returns the current status of the switch/button
+
+### Status messages from the node
+
+As soon as a key has been pressed, the following status message is returned by the node:
+
+#### Status object under `msg.payload`
+
+: reachable (boolean | string): `true` if the switch/button is connected to the bridge, `unknown` if the connection status deviates
+: connectionStatus (string): The current connection status with the bridge in the form of a string. Can contain `connected`, `disconnected`, `connectivity_issue` or `unidirectional_incoming` as a value
+: button (int | boolean): Numeric ID of the key that was last pressed or `false` if no key was pressed
+: action (string | boolean): `false` if no key was pressed or `initial_press`, `repeat` , `short_release`, `long_release` or `double_short_release` in the form of a string
+: updated (string): Time of the last update of the resource by HueMagic (ISO 8601)
+
+#### Information about the switch/button under `msg.info`
+
+: id (string): Indicates the new ID of the switch/button
+: idV1 (string | boolean): Indicates the old ID of the switch/button
+: uniqueId (string): The unique ID of the switch/button
+: deviceId (string): The unique ID of the device
+: name (string): The currently set name of the switch/button
+: type (string): The type of the switch/button (always `button`)
+: softwareVersion (string): The current firmware of the switch/button
+: battery (float): The current battery level of the switch/button
+: batteryState (string): The current status of the battery level. Can contain `normal`, `low` or `critical` as a value
+: model (object): Contains the model information of the switch/button under `id` , `manufacturer`, `name`, `type` and `certified`
+
+#### Status changes under `msg.updated`
+
+Lists individual parameters in the form of an object that have changed compared to the last state of the switch/button. If no changes have been registered, this object is empty.
+
+#### Last status of the switch/button under `msg.lastState`
+
+Contains the complete status object (see output values above) of the last status before the last registered change. If the last state of HueMagic has not yet been registered, it will output `false`.
+
+#### Last command under `msg.command` (optional)
+
+If the status of the node has changed via a certain command, the entire command that was executed is also output. Otherwise this object will not be output by the node.
+
+### Examples from HueMagic
+
+HueMagic provides some sample configurations for this node. To import a full featured example into your Node-RED interface, click on the Node-RED menu icon, then select "Import" and navigate to "Examples" in the sidebar of the popup. Then select the HueMagic folder and your desired node to import a sample flow.
+
+![examples](https://user-images.githubusercontent.com/5302050/148681840-2275c15a-7c0c-4a37-b817-199608e571d2.gif)
+</script>

package/huemagic/locales/en-US/hue-buttons.json

@@ -0,0 +1,34 @@
+{
+	"hue-buttons":
+	{
+		"config":
+		{
+			"name": "Name",
+			"input-name": "Button name",
+			"skipevents-node": "Skip events from node",
+			"sendinitevents-node": "Do not suppress initialization event",
+			"searching": "Searching Hue Buttons…",
+			"none-found": "No Hue Button found!",
+			"unknown-error": "Something went wrong. Please retry.",
+			"button": "Button",
+			"universalevents": "Universal Events",
+			"universalevents-node": "Receives all messages from other nodes of the same type (only in universal mode)"
+		},
+		"node":
+		{
+			"title": "Hue Buttons",
+			"not-configured": "not configured",
+			"waiting": "waiting…",
+			"button-on": "On",
+			"action-pressed": "pressed",
+			"action-holded": "held",
+			"action-shortreleased": "short released",
+			"action-longreleased": "long released",
+			"input": "status query",
+			"output": "pressed button",
+			"universal": "universal mode",
+			"command": "executing command…",
+			"statusmsg": "Status queried successfully…"
+		}
+	}
+}