PlugHub module API ( require “plughub” )

subscribe()

Edit

Subscribe a script for PlugHub events. After subscribing the script will be launched for each event happens on a PlugHub addon and information about this event will be passed as a parameter.

Edit

plughub.subscribe()

Edit

params: script name (string).

Edit

return: none.

Edit

				
					 local plughub = require "plughub"

    plughub.subscribe( "HUB:plughub/scripts/events_handling" )

unsubscribe()

Edit

Unsubscribe a script from PlugHub events.

Edit

plughub.unsubscribe()

Edit

params: script name (string).

Edit

return: none.

Edit

				
					local plughub = require "plughub"

    plughub.unsubscribe( "HUB:plughub/scripts/events_handling" )

request_all_values()

Edit

Request updating of all plughub values

Edit

plughub.request_all_values()

Edit

params: none

Edit

return: none

Edit

				
					local plughub = require "plughub"

    plughub.request_all_values()

reset_consumed_energy_meter()

Edit

Reset consumed energy meter to default (sets value to 0.0)

Edit

plughub.reset_consumed_energy_meter()

Edit

params: none.

Edit

return: none.

Edit

				
					local plughub = require "plughub"

    plughub.reset_consumed_energy_meter()

set_switch_value()

Edit

Set switch value

Edit

plughub.set_switch_value()

Edit

params: value (bool).

Edit

return: none.

Edit

				
					local plughub = require "plughub"

    plughub.set_switch_value(true)