[MMM-ValuesByNotification] Display the payloads of notifications with titles and icons

wishmaster270 · Oct 4, 2022, 12:18 PM

Description:

Need a MagicMirror² module which is able to display information which is send by a other module like MMM-MQTTbridge or MMM-CommandToNotification?
The information is provided as a simple message or as an JSON-Object?
You want to re-format the message before displaying it or want to select single values within the JSON-Object?
You need more than one instance and do want to style the instances different?
Do you want to style the elements or change displayed icons based on thresholds?
Do you want some elements to only be visible if a certain profile is active?

Then this is the module you need!

BUT i think i created a monster. The configuration can be very tricky!

Screenshots:

Download:

Download
[card:Tom-Hirschberger/MMM-ValuesByNotification]

Version 0.1.6

bumped version of jsonpath-plus library to 10.3.0

Version 0.1.5

bumped version of jsonpath-plus library to 10.1.0

Version 0.1.4

it is possible to set the reuseCount on group level now

Version 0.1.3

added a postinstall script which creates a copy of the imported JSONPath library cause MagicMirror only imports files with ending js and not cjs to fix JSONPath

Version 0.1.2

bumped jsonpath-plus library to version 10.0.1
do not log every received notification anymore
be more verbose if debug is enabled and the value format fails

Version 0.1.1

Reverted the jsonpath-plus dependency upgrade (used version is 5.1.0 now) cause version 7.2.0 only worked with the newest MagicMirror version (2.24.0)
fixed a bug which caused empty values to be converted to html and causing a exception in this process
introduce a debug config flag which causes some more information being printed to console if enabled

Version 0.1.0

Each time a value is reused the values html elements get two classes added. The one configured with the new config option reusedClass (default: “reused”) and the config option prefixed by a “-” and the count of reuses.
Updated the jsonpath-plus dependency to version 7.2.0. As this required a change to the import of the module this is a breaking change.

Version 0.0.10

Introducing a feature to define own functions to transform the values (valueTransformers). Added a example to values documentation
Changed the way titles, values and units are converted the html elements
Added a new option called unitSpace to prefix the unit with a non-breakable space

Special thanks to @BKeyport for contribution

Version 0.0.9

fixed a bug which caused selected JSON values with value 0 being interpreted as not existing and replaced by naValue

Version 0.0.8

fixed a bug which caused values not being formatted if values before format are not of type String
fixed a bug which caused newline replacement called even if no valueFormat was set

Version 0.0.7

added new option valueNaPositions which defines the positions of title, value, unit and icon of the value elements if naValue is used
added support to override valuePositions by threshold configurations (will override valueNaPositions, too!)

Version 0.0.6

only the first element of a jsonpath result is used now
if html is added as value which contains more than one html element they are wrapped in a span now

Version 0.0.5

added support of Iconify icons
all CSS definitions are now prefixed with the modules main class (MMM-ValuesByNotification)

Version 0.0.4

fixed handling of new line characters in notifications; new lines will be replaced now before handling the values (default is a single space, see newlineReplacement option)
fixed classes not bubbling up correctly
added a flowercare example

Version 0.0.3

if searching the value with “jsonpath” fails the “naValue” will be set now
added a new option “formatNaValue” which controls if the naValue should be formatted as the regular are

Version 0.0.2

Only classes which are added by thresholds are now set to higher (wrapper) elements if “letClassesBubbleUp” is set to “true”

Version 0.0.1

Display values received as payload of notifications either as String or JSON Object
Select single values with Jsonpath within the JSON objects
Re-format the values with javascript functions (see valueFormat option)
Group the values in items and groups and add titles and/or icons to the wrappers
Re-order the elements in the wrappers based on position definition strings
Filter elements based on the current active profile (MMM-ProfileSwitcher)
Add classes or change icons based on thresholds reached by the values

Cr4z33 · Oct 4, 2022, 1:30 PM

@wishmaster270 soooo I gave a deep reading at your readme, but I am not quite sure whether I can already insert my MQTT based power meter with your first release or not? :slightly_smiling_face:

wishmaster270 · Oct 4, 2022, 1:31 PM

@Cr4z33
Hi,
the short answer: Yes it can, maaayyyybee?
Does your powermeter send the data via MQTT already?
Do you have the MMM-MQTTbridge module configured to connect to your MQTT broker, subscribe for the topic(s) and send the data via notification?
How does the data look like? Is it plain text or is it a JSON object?
If it is JSON how is the data structured and which values do you want to display?

Cr4z33 · Oct 4, 2022, 1:47 PM

@wishmaster270 said in [MMM-ValuesByNotification] Display the payloads of notifications with titles and icons:

Does your powermeter send the data via MQTT already?

Yes

Do you have the MMM-MQTTbridge module configured to connect to your MQTT broker, subscribe for the topic(s) and send the data via notification?

Nope, but I will set it up as soon as I finish posting this reply! :thumbs_up_light_skin_tone:

How does the data look like? Is it plain text or is it a JSON object?

I’ve got Zigbee2MQTT running in a Docker and if I look at its logs it shows lines like

Zigbee2MQTT:info  2022-10-04 15:45:08: MQTT publish: topic 'zigbee2mqtt/BTicino F20T60A', payload '{"device":{"applicationVersion":0,"dateCode":" \u000020180829\u0000\u0000\u0000\u0000\u0000","friendlyName":"BTicino F20T60A","hardwareVersion":1,"ieeeAddr":"0x000474000089a3e4","manufacturerID":4129,"manufacturerName":" Legrand\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000","model":"412015","networkAddress":16238,"powerSource":"Mains (single phase)","softwareBuildID":"016\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000 \u0002\u0000\u0001\u0000 \u0002\u0000\u0002\u0000!\u0012\u0000\u0000\u0000\u0000  \u0003\u0000\u0010\u0002\u0001\u0004\u0000\u0018\u0002\u0000  !","stackVersion":64,"type":"Router","zclVersion":2},"linkquality":90,"power":645,"power_alarm":null,"power_alarm_active":true,"power_alarm_active_value":2}'

Zigbee2MQTT:info  2022-10-04 15:45:10: MQTT publish: topic 'zigbee2mqtt/BTicino F20T60A', payload '{"device":{"applicationVersion":0,"dateCode":" \u000020180829\u0000\u0000\u0000\u0000\u0000","friendlyName":"BTicino F20T60A","hardwareVersion":1,"ieeeAddr":"0x000474000089a3e4","manufacturerID":4129,"manufacturerName":" Legrand\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000","model":"412015","networkAddress":16238,"powerSource":"Mains (single phase)","softwareBuildID":"016\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000 \u0002\u0000\u0001\u0000 \u0002\u0000\u0002\u0000!\u0012\u0000\u0000\u0000\u0000  \u0003\u0000\u0010\u0002\u0001\u0004\u0000\u0018\u0002\u0000  !","stackVersion":64,"type":"Router","zclVersion":2},"linkquality":90,"power":610,"power_alarm":null,"power_alarm_active":true,"power_alarm_active_value":2}'

If it is JSON how is the data structured and which values do you want to display?

I want to display the power value.

wishmaster270 · Oct 4, 2022, 2:07 PM

@Cr4z33
Should be no problem:

MMM-MQTTbridge/dict/mqttDictionary.js:

var mqttHook = [
  {
    mqttTopic: "zigbee2mqtt/BTicino F20T60A",
    mqttPayload: [
      {
        payloadValue: "",
        mqttNotiCmd: ["POWERMETER"],
        mqttPayload: ""
      },
    ],
  },
];

var mqttNotiCommands = [
  {
    commandId: "POWERMETER",
    notiID: "POWERMETER_VALUES",
  },
];

module.exports = { mqttHook,  mqttNotiCommands};

config.js:

		{
			module: "MMM-ValuesByNotification",
			position: "top_left",
			config: {
                                updateInterval: 60,
                                reuseCount: 5,
				groups: [
					{
						items: [
							{
								notification: "POWERMETER_VALUES",
								itemTitle: "Power",
								values: [
									{
										valueUnit: "W",
										jsonpath: "power",
									},
								]
							},
						]
					},
				]
			},
		},

Will look like:

You may want to configure the updateInterval and/or reuseCount to your needs.

Cr4z33 · Oct 4, 2022, 2:40 PM

@wishmaster270 thank you it worked at first try!

Now I can go on with some aesthetic changes like icons, etc. :D

wishmaster270 · Oct 4, 2022, 2:44 PM

@Cr4z33

Just tested a view things.
If you like you can use font awesome icon instead of the title:

		{
			module: "MMM-ValuesByNotification",
			position: "top_left",
			config: {
                                updateInterval: 60,
                                reuseCount: 5,
				groups: [
					{
						items: [
							{
								notification: "POWERMETER_VALUES",
								//itemTitle: "Power",
								values: [
									{
										classes: "power",
										valueIcon: "fa fa-bolt",
										valueUnit: "W",
										jsonpath: "power",
									},
								]
							},
						]
					},
				]
			},
		},

custom.css:

.vbn .valueIcon.power {
  color: orange;
}

Cr4z33 · Oct 4, 2022, 3:18 PM

@wishmaster270 thanks I applied that instead.

Anyway to add some offset to the module to be aligned with the other modules on the left?

wishmaster270 · Oct 4, 2022, 3:19 PM

@Cr4z33
sorry i do not understand exactly what you mean

Cr4z33 · Oct 4, 2022, 3:24 PM

@wishmaster270 I wanted to move your module way more to the left so to align it with my other modules (Google Assistant, clock and Spotify).

However nevermind as I opted to have your module on top instead. ;)