View Categories

Examples of interactions between BleBox controllers

0:00 10:54

Each controller has its own API type, which can be checked in the ‘Details, Updates and Help’ tab; for example, the tempSensor temperature sensor has the multiSensor API type.

Detailed documentation can be found at this link: https://technical.blebox.eu/

switchBox

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is the digit described below:

  • 0 – turns off
  • 1 – turns on
  • 2 – reverses the status (if it was on, it switches it off, and vice versa)

Advanced:

  • 1/forTime/(…TIMES…)/ns/0

where (…TIMES…) is the time, in seconds, for which the switchBox is to be switched on

Examples:

  • 1/forTime/5/ns/0 – the connected device will be switched on for 5 seconds

A switchBox with several outputs

For actions of the type: ‘Send URL’:
– http://IP/s/(…OUTPUT…)/(…REQUEST…)

For actions of the type: control another device:
– (…OUTPUT…)/(…REQUEST…)

where (…OUTPUT…) is the digit described below:

  • 0 – first output (O1)
  • 1 – second output (O2)

where (…REQUEST…) is the digit described below:

  • 0 – turns off
  • 1 – turns on
  • 2 – reverses the status (if it was on, it switches it off, and vice versa)

Examples:

  • 0/1 – will enable output O1
  • 1/1 – activates the O2 output
  • 0/2 – will reverse the state of output O1 (if the output was on, it will switch it off, and vice versa)

Advanced:

  • (…OUTPUT…)/1/forTime/(…TIMES…)/ns/0

where (…OUTPUT…) is the output number (see above) and where (…TIMES…) is the duration, in seconds, for which the switchBoxD output is to be switched on.

Examples:

  • 0/1/forTime/5/ns/0 – will switch output O1 on for 5 seconds
  • 1/1/forTime/5/ns/0 – will activate the O2 output for 5 seconds

wLightBoxS and dimmerBox

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is the brightness value in WW format. It is represented in hexadecimal as a two-character value (00–FF, which corresponds to the decimal range 0–255):

  • 00 – switches off
  • FF – turns on, sets the brightness to 100%

Examples:

  • 00 – will switch off
  • 19 – turns it on and sets the brightness to 10 per cent
  • 33 – turns it on and sets the brightness to 20 per cent
  • 4D – turns it on and sets the brightness to 30%
  • 66 – turns it on and sets the brightness to 40 per cent
  • 7F – turns it on and sets the brightness to 50%
  • 99 – turns it on and sets the brightness to 60 per cent
  • B3 – turns it on and sets the brightness to 70 per cent
  • CC – will switch it on and set the brightness to 80%
  • E6 – turns it on and sets the brightness to 90 per cent
  • FF – turns it on and sets the brightness to 100%

Advanced features in LightBoxS:

  • offon/last —> changes the state – off / last state (last brightness)
  • onlast —> always sets the last state
  • inc/XX —> increases the current brightness by XX (hex)
  • dec/XX —> reduces the current brightness by XX (hex)
  • x/(…EFFECT_ID…) —> activates the effect with the specified ID (0–9)
  • x/(…EFFECT_ID…)/forTime/(…TIME_S…) —> activates the specified effect for the specified duration
  • XX/colorFadeMs/(…TIME_MS…) —> activates the specified brightness with the set fade-in time
  • XX/forTime/(…TIME_S…) —> turns the light on at the specified brightness for the set duration
  • s/XX/colorFadeMs/(…TIME_MS…)/forTime/(…TIME_S…) —> sets the specified brightness for the specified duration with the specified fade-in time

where XX is a value between 0 and FF, (…TIME_S…) is the time in seconds, (…TIME_MS…) is the fade-in time in milliseconds, and (…EFFECT_ID…) is a digit – the effect number from the app (0–9).

Advanced dimmerBox:

  • offon/last —> changes the state – off / last state (last brightness)
  • offon/toggle —> changes the state – off / on (max 100%)
  • offon/XX —> changes the state to off / XX (brightness in HEX 00–FF)
  • onlast —> always sets the last state
  • onfull —> always sets it to maximum (just like /s/FF)
  • off —> turns off (same as /s/00)
  • inc/XX —> increases the current brightness by XX (hex)
  • dec/XX —> reduces the current brightness by XX (hex)

wLighBox (5CH) and pixelBox

Actions (commands) for the wLightBox and pixelBox products:

For actions of the type: ‘Send URL’:
– http://IP/s/(…CHANNELS…)

For actions of the type: control another device:
– (…CHANNELS…)

where (…CHANNELS…) refers to 5 brightness values (RR-GG-BB-WW-CW). These are stored in hexadecimal format, using two characters for each colour/channel of the LED strip (00–FF, which corresponds to the decimal values 0–255), as follows:

  • RR – i.e. 00–FF (0–255) – red colour brightness / channel 1
  • GG – i.e. 00–FF (0–255) – green colour brightness / channel 2
  • BB – i.e. 00–FF (0–255) – brightness of the blue colour / channel 3
  • WW – i.e. 00–FF (0–255) – brightness of warm white / channel 4
  • CW – i.e. 00–FF (0–255) – brightness of cool white / channel 5

Converted brightness scale:

  • 00 – 0% brightness
  • 19 – 10% brightness
  • 33 – 20% brightness
  • 4D – 30% brightness
  • 66 – 40% brightness
  • 7F – 50% brightness
  • 99 – 60% brightness
  • B3 – 70% brightness
  • CC – 80% brightness
  • E6 – 90% brightness
  • FF – 100% brightness

Examples:

  • 0000000000 – turns off the LED strip / all channels off
  • FF00000000 – turns on the colour red / channel 1 on, the rest off
  • 00FF000000 – sets the colour to green / channel 2 on, the rest off
  • 0000FF0000 – turns on the colour blue / channel 3 on, the rest off
  • 000000FF00 – turns on warm white / channel 4 on, the rest off
  • 00000000FF – sets the colour to cool white / channel 5 on, the rest off
  • FFFFFF0000 – sets the colour to white (red, green, blue)
  • FFFF000000 – sets the colour to yellow (red, green)
  • FF00FF0000 – will set the colour to fuchsia (red, blue)
  • 00FFFF0000 – will enable the colour cyan (green, blue)
  • FF7F000000 – sets the colour to orange (red, 50% green)

Advanced:

  • offon/last

will switch the most recently set colour/brightness of the channels on or off. In other words, if the LED strip is on, it will be switched off; if it is off, the most recently set colour will be switched on.

  • (…CHANNELS…)/forTime/(…TIMES…)

where (…CHANNELS…) refers to the 4 brightness values (see above) and where (…TIMES…) refers to the duration, in seconds, for which the specified brightness/colour is to be active.

  • x/(…EFFECT_ID…)

where (…EFFECT_ID…) is a digit – the effect number from the app (0–9).

Examples:

  • offon/last – enables or disables the most recently set colour/brightness for the channels.
  • FF00000000/forTime/5 – will display the colour red for 5 seconds
  • x/0 – will disable the effect
  • x/1 – activates effect number 1
  • x/5 – activates effect number 5

shutterBox

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is a character or a value (in the case of a calibration carried out on the controller) as described below:

  • u – open
  • d – close
  • s – stop
  • n – the next command in the sequence (the next command in the open-stop-close-stop sequence)
  • f – favourite position (only with a calibrated controller)

Examples:

  • u – will open
  • d – will cause it to close
  • s – will cause a stop
  • n- will trigger the next command in the open-stop-close-stop sequence
  • f – will ‘navigate’ to your favourite position

Advanced:

  • p/(…VALUE_PERCENTAGE…)
  • t/(…VALUE_PERCENTAGE…)

where (…VALUE_PERCENTAGE…) is a number between 0 and 100 representing the closing percentage (only for a calibrated controller).

Examples:

  • p/0 – will cause it to open (the same as ‘u’)
  • p/100 – will cause a close (equivalent to d)
  • p/50 – will close the gate halfway
  • t/0 – sets the slats to their minimum position, depending on the motor
  • t/100 – sets the slats to their maximum position, depending on the motor
  • t/50 – this will adjust the slats according to the motor

rollerGate

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is the character described below:

  • o – open
  • c – close
  • s – stop
  • n – the next command in the sequence (the next command in the open-stop-close-stop sequence)
  • w – transition/ventilation position (only with a calibrated controller)

Examples:

  • o – will open
  • c – will cause it to close
  • s – will cause a stop
  • n – will trigger the next command in the open-stop-close-stop sequence
  • w – will cause the car to ‘drive’ to a favourite location, a pedestrian crossing or a ventilation point

Advanced:

  • p/(…VALUE_PERCENTAGE…)

where (…VALUE_PERCENTAGE…) is a number between 0 and 100 indicating the percentage of the gate’s closure (only with a calibrated controller).

Examples:

  • p/0 – will cause an opening (equivalent to o)
  • p/100 – will cause a close (equivalent to c)
  • p/50 – will close the gate halfway

gateBox

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is the character described below:

  • p – control the first output (pulse to the gate controller’s button input)
  • s – control the second output (pulse to the gate controller’s push-button input), (not applicable for doorBox)

Examples:

  • p – will control the first output
  • s – will activate the second output (not available on the doorBox)

saunaBox

Actions (commands) for the saunaBox product:

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is the digit described below:

  • 0 – switch off the heating
  • 1 – switch on the heating at the last set temperature

Examples:

  • 0 – will switch off the heating
  • 1 – will switch on the heating at the last set temperature

Advanced:

  • t/(…TEMPERATURE_X100…)

where (…TEMPERATURE_X100…) is the temperature multiplied by 100, i.e. from -5,500 to 12,500 (from -55 to +125).

Examples:

  • t/0 – sets the temperature to 0 degrees (does not switch the sauna on or off)
  • t/125 – sets the temperature to 125 degrees (does not switch the sauna on or off)
  • t/60 – sets the temperature to 60 degrees (does not switch the sauna on or off)

thermoBox

For actions of the type: ‘Send URL’:
– http://IP/s/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is the digit described below:

  • 0 – switch off the controller
  • 1 – switch on the controller set to the last temperature selected
  • 3 – switch to BOOST mode

Examples:

  • 0 – will switch off the heating
  • 1 – will switch on the heating at the last set temperature

Advanced:

  • 1/t/(…TEMPERATURE_X100…)
  • 0/t/(…TEMPERATURE_X100…)
  • t/(…TEMPERATURE_X100…)
  • t/inc/(…TEMPERATURE_X100…)
  • t/dec/(…TEMPERATURE_X100…)

where (…TEMPERATURE_X100…) is the temperature multiplied by 100, i.e. from -5,500 to 12,500 (from -55 to +125).

Examples:

  • 1/t/2300 – this will switch on the controller and set the temperature to 23 degrees
  • t/2000 – will set the temperature to 20 degrees (does not switch the controller on or off)
  • t/2250 – sets the temperature to 22.5 degrees (does not switch the controller on or off)
  • 0/t/2100 – this will switch off the controller and set the temperature to 21 (e.g. for future heating)
  • t/inc/100 – will increase the temperature by 1 degree
  • t/dec/50 – will reduce the temperature by 0.5 degrees

actionBox

For actions of the type: ‘Send URL’ (note: this differs from other drivers)
– http://IP/t/(…REQUEST…)

For actions of the type: control another device:
– (…REQUEST…)

where (…REQUEST…) is /, where:

  • <button number> is a number from 0 to 3 (corresponding to the numbers of the actionBox buttons labelled 1–4)
  • <trigger number> is the trigger set in actionBox:
    • 1 – a short click
    • 2 – long press
    • 3 – falling edge (e.g. releasing a button)
    • 4 – rising edge (e.g. pressing a button)
    • 5 – edge (e.g. both releasing and pressing)

Examples:

  • 0/1
  • 2/5

multiSensor

Actions (commands) for the saunaBox product:

For actions of the type: ‘Send URL’:
– http://IP/(…ENDPOINT…)

where (…ENDPOINT…) is the path described below:

  • state – returns the basic status of the sensors (id, type, value, state, trend, elapsedTimeS)
  • state/extended – will display the full sensor data, along with their names and icons

Types of sensors (type in response to state)

  • temperature – temperature
  • Other types depending on the model/configuration of the probes – see api/probes/state

Fields describing a single sensor

  • id – sensor number
  • type – sensor type
  • value – current value
  • state – measurement status (numeric code)
  • trend – direction of the trend (numeric code)
  • elapsedTimeS – time (s) since the last measurement
  • iconSet (state/extended only) – icon assigned to the sensor
  • name (state/extended only) – the name given to the sensor

Scroll to Top