Updating uOS through uControl

Your HDA device will be supplied with the latest stable software version already installed. To access the latest features or maintain your system, it is recommended that you perform periodic updates to uOS. This process must be done manually as we do not push updates to systems automatically. Ensure that your system has access to a good internet connection and that power to your uOS device is stable during the process.


In this support article:

 

If you are not connected to a device

1. Open uControl app

Launch uControl and you will see the home page.


You now need to press advanced.

2. Press “Update”

This is the advanced screen where you can find your devices, connect over WiFi, reset your system and more.


Your IP address will be needed here so uControl knows which device is looking for an update.

3. Enter the devices IP address

If you don’t have this you can get it by finding the IP address of your device.


Once you have typed in your IP address, press “Continue”.

4. Updating your device

A. If there is an available update press “Update Device”.
B. If your device is already up to date, exit this page.


If your HDA device has an issue that prompted you to update, but it is already up to date please contact support.

5. Terms and Conditions

To proceed accept the End User Licence Agreement (EULA) and Privacy Statement.


For more information click on the terms.

6. Update begins

This process can take up to 5 minutes, however, depending on your network it could be longer.


Please do not switch off your HDA device whilst updating.

7. Update completed

uControl will display your OS Version.


Press “Update Finished”.

If you are connected to a device

1. Open up uControl

If you’re already connected to a system then you will need to access uControl’s settings. From the main screen you will see something similar to this (see below). From here, look for a menu icon (three horizontal lines) in the top left corner, press that to reveal the Zone selector and Zone control menu.


What you see on the main screen may differ, however, the three lined menu bar will still be there.

2. Navigate to your settings

Look for the settings icon located in the bottom left corner.


The icon may vary depending on your mobile devices size, however, it will still be in the bottom left corner.

3. Press “Utilities”

This will take you to your devices service page.


From here you can also see your connected devices IP address(s).

4. Press “Update”

From this page you can also find your devices, and reset one. To find out more check out our uOS Utilities page.


The next page will show you your connected HDA devices.

5.“Available Systems”

If you have a stacked system, or multiple devices they will show here.


Once an update is found you will be taken to the update screen.

6. Begin update

If your device is updateable it will start, and include which version you’re updating to.


Press “Update Device”.

7. Terms and Conditions

To continue please acknowledge the legal terms.


For more information on the legal terms, you can read the End-User Licence Agreement (EULA) and the Privacy Statement.

8. Await download

This process can take up to 5 minutes, however, depending on your network it could be longer.


Please make sure not to power down your device whilst the update is downloading.

9. Update completed

uControl will now let you know the update is complete.


Press “Update Finished”.

How to find available systems through uControl

Your HDA device will be displayed as an available system when connected to uControl. You may have more than one device connected, or be operating a stack and need to see which devices are connected.


In this support article:


 

When you’re not connected in uControl

1. Open uControl app

Launch uControl and you will see the home page.


You now need to press advanced.

2. Press “Find Devices”

This is the advanced screen where you can find your devices, connect over WiFi, reset your system and more.


It is the main navigation page for your devices options.

3. Available Systems(s)

This is where your connected devices will show.


If you have more than one connected device, you can click “identify” to make the power LED of that unit flash.

When you’re connected in uControl

1. Open up uControl

If you’re already connected to a system then you will need to access uControl’s settings. From the main screen you will see something similar to this (see below). From here, look for a menu icon (three horizontal lines) in the top left corner, press that to reveal the Zone selector and Zone control menu.


What you see on the main screen may differ, however, the three lined menu bar will still be there.

2. Navigate to your settings

Look for the settings icon located in the bottom left corner.


The icon may vary depending on your mobile devices size, however, it will still be in the bottom left corner.

3. Press “Utilities”

This will take you to your devices service page.


From here you can also see the IP address of the device you’re currently controlling.

4. Press “Find Devices”

From this page you can also update, and reset your HDA device. To find out more check out our uOS Utilities page.


The next page will show you your connected HDA devices.

5. Available Systems(s)

If you have a stacked system, or multiple devices they will show here.


If you have more than one connected device, you can click “identify” to make the power LED of that unit flash.

Finding the IP address of your device

Your HDA device broadcasts its IP address using a protocol called mDNS over your Local Area Network (LAN). The easiest way to find your IP address is to use our app, uControl.


In this support article:

 

Finding your device on a (new/reset) system


1. Open uControl app

Launch uControl and you will see the Home Page.


You now need to press advanced.

2. Press “Find Devices”

This is your Advanced Page where you can find the HDA systems connected to your network.


From here you can find your devices, connect over WiFi, reset your system and more.

3. “Available System(s)”

Your connected devices will show here along with their IP address.


If you have more than one device you can use the identify button to make the power LED blink.


Finding your device if you’re already connected to a system

1. Open up uControl

If you’re already connected to a system then you will need to access uControl’s settings. From the main screen you will see something similar to this (see below). From here, look for a menu icon (three horizontal lines) in the top left corner, press that to reveal the Zone selector and Zone control menu.


What you see on the main screen may differ, however, the three lined menu bar will still be there.

2. Navigate to your settings

Look for the settings icon located in the bottom left corner.


The icon may vary depending on your mobile devices size, however, it will still be in the bottom left corner.

3. Utilities

This is your device page which displays your model and IP address, if you want a list of all connected devices go to utilities.


From here you can also add another device to your setup using the plus sign in the top right.

4. Find Devices

This page is where you can update, reset or find your available connected systems.


To reset your system as you can see below, you will need to press it 10 times.

5. Available Systems

Here you will see all your connected devices, and their IP addresses.


If you have multiple devices connected, you can distinguish between them by pressing the identify button which will make the power LED flash.

What is “uControl inside” on MHUB or Zone Processors

horizontal_uC_inside_colour_lightBG@3x

If you see a HDANYWHERE or third party device marked with “uControl inside” then it contains our control system inside it. You can find out what it can do by visiting uControl’s website here.

Comparing AV and Full versions of uControl inside

Some devices are marked “AV” where others are “Full”. This is determined by the operating system found on the device. The “full” implementation of uControl can be found in devices which have uControl OS (uOS) inside. “AV” means that the system is running MHUB-OS (MOS) and control capability is restricted to AV only or the devices that are directly connected to the MHUB system.

Full

  • Control over sources, AVRs, displays and projectors (IR)
  • Control over sources, AVRs, displays and projectors (IP/CEC)
  • IP control over lighting, blinds, shades, PDUs, relays and more See all here
  • uControl app, Alexa, Watch support
  • uControl Remote
  • Super Sequences, Functions and Scheduling

AV

  • Control over sources, AVRs, displays and projectors (IR)
  • uControl app, Alexa, Watch support
  • uControl Remote*
  • Sequences and Scheduling

Upgrading an older MHUB to support Full uControl

It may be possible to update your MHUB’s control capabilities by adding a uControl Zone Processor to manage your system instead. Not all models are supported so we recommend contacting us to confirm the level of support first.

*Requires a Zone Processor to be added to the system to upgrade to Full uControl capabilities.

Controlling Lutron from uOS

This guide explains how to pull data from Lutrons API protocol so you can control QS Standalone, RadioRA2, Quantum, Athena, HomeWorks QS, myRoom plus from Lutrons devices.

Lutron in uOS

What this guide will cover:

  1. How to control Lutron lights in your home.
  2. How to add that API into uOS.
  3. QS Standalone, RadioRA2, Quantum, Athena, HomeWorks QS, myRoom plus.

Important: you must have the IP addresses first

For the purposes of this guide we are going to assume that your Lutron gateway is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

Important: This guide assumes that you are familiar with Lutron and know how to use their lighting infrastructure and that your Lutron system is operational before integrating into uOS.

What a Telnet Lutron command looks like

See “Testing your API’s” for more information on Telnet.

#OUTPUT,2,1,75,00:30

Understanding what the variables above mean:

#OUTPUT
This is the operation character for executing an action. For more information on these see the slideshow below.

,2
The first number in the string is the ID for the device.

,1
The second number in the string is the action number, which in this instance is enable.

,75
This number sets the level of the dimmer, so in this case 75%.

,00:30
This is the fade time of the dimmer.


Testing your APIs

We recommend that you test every API before you enter them into uOS. All IP based APIs have different requirements when it comes to testing, Lutron’s method is a little different as it needs to be done over Telnet in command prompt.

To test your commands, open up command prompt on your laptop or PC and enter telnet 192.168.1.15 23

Remember, your IP address will be different, you must use the Lutron gateway IP address for this, the port is 23.

You now need to wait for it to connect which may take a few minutes, then you will be asked to login. The username is lutron, and the password is integration. You will now be able to test your commands in the terminal. Observe the device you are trying to control, and see if your commands changes the outcome.

Using a MAC?

If you are using a MAC you can use Netcat to test your API command. To do so open your terminal and enter nc 192.168.1.15 23

Wait for it to connect and then you will be prompted to login. The username is lutron and the password is integration.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing a light in the correct room and location.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling SilentGliss from uOS

This guide explains how to pull data from the SilentGliss API so you can control it directly from uOS.

Shelly in uOS

What this guide will cover:

  1. How to control SilentGliss window coverings in your home.
  2. How to add that API into uOS.

Important: you must have the IP addresses first

You can get the IP address of your SilentGliss gateway device:

  1. Use a network discovery app like Fing to find the SilentGliss gateway on your network.

What a typical SilentGliss API command looks like

192.168.1.15/sgbms/v1/device/7/command

This command only shows the structure and does not include the actual action of the command which needs to be included in the body. This will be explained further through the guide.

192.168.1.15/
This is the IP addresss of the gateway, a forward slash (/) needs to be added between each unique variable.

sgbms/v1
This is the URL version of the gateway.

device/7
This specifies we are affecting a device and what its ID is.

command
Command must go at the end as we are performing a POST execution method which is atempting to perform an action.

Testing your APIs

We recommend testing your API command before entering it into uOS to ensure it works. To do this we recommend installing an application called Postman.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing a light in the correct room and location.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling KNX from uOS

This guide explains how to pull data from KNX’s protocol so you can control it directly from uOS.

KNX in uOS

Please note: this guide assumes you have access and knowledge of ETS6, and your own KNX/Weinzierl gateway. In this guide we are using a BAOS 774 gateway, but you may have a different one, so refer to this site for more Weinzierl product knowledge.

What this guide will cover:

  1. How to control KNX devices in your home.
  2. How to add that API into uOS.

Important: you must have the gateway IP address first

You can get the IP address of your gateway by:

  • Use a network scanner application like Fing on your mobile phone to scan your network.
  • You can also get the IP address from the properties tab of the device in KNX’s ETS.

For the purposes of this guide we are going to pretend that your Weinzierl gateway is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

What a typical BAOS API command looks like

http://192.168.1.15/baos/SetDatapointValue?Datapoint=2&Format=DPT1&Length=1&Value=false

The above command will trigger our BAOS gateway to send a telegram to datapoint 2, which will switch off our light.

Understanding what the variables in the API above mean:

http://192.168.1.15
The command starts with http:// as it can be sent over a URL, followed by the IP address of your KNX/Weinzierl gateway.

/baos/
This is the device type of a Weinzierl device.

SetDatapointValue?Datapoint=2
Here we are setting this command to send to our KNX data point to two.

&Format=DPT1
This is the sub data point, and sets the rules of which values are allowed.

&Length=1&Value=false
This is the length of the data point type, and the value is boolean therefore setting it on or off.

Testing your APIs

We recommend that you test every API before you enter them into uOS. All IP based APIs all have different requirements when it comes to testing but the KNX API is great because it can be tested on your browser.

To test your API, open a web browser and enter the full API (including http://192.168.1.15) in the URL window and hit enter.

If the KNX device responds as you expected then your API is working and you can proceed adding it into uOS.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing the correct device.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling AudioFlow from uOS

This guide explains how to control your AudioFlow switch from uOS.

Audioflow switching in uOS

What this guide will cover:

  1. Understanding switching outputs.
  2. How to create an AudioFlow API so that you can control your speakers in the property.
  3. How to add that API into uOS.

Important: you must have the IP address for AudioFlow first

You can get the IP address of your AudioFlow switch by:

  • Using a network scanner application like Fing on your mobile phone to scan your network.
  • Download the AudioFlow app and connect it to your network. From here go to settings, and you will see its IP address.

For the purposes of this guide we are going to pretend that your AudioFlow switch is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

Before we begin, each AudioFlow switch has its zones predefined. The smallest switch available is a 2-way switch which has zones A and B, then a 3-way switch which has zones A, B and C and lastly a 4-way switch, which has zones A, B, C and D.

  • Zone A is equal to 1.
  • Zone B is equal to 2.
  • Zone C is equal to 3.
  • Zone D is equal to 4.

AudioFlow API

192.168.1.15/zones/2

The above command will trigger a switch in Zone B. You will then need to input either a 1 in the body to switch it on, or a 0 to switch it off. For a more in depth description of this, see our slideshow below.

The method for an AudioFlow command is PUT. You will need to separate each section of the command with a /

Understanding what the variables in the API above mean:

192.168.1.15/
This is the IP address of your AudioFlow switch, and will be needed when sending a command over http. Once an IP connection is made to uOS, this will not need to be included.

zones/
This specifies which audio zones you are switching. If you don’t include the zone number, your payload will trigger all zones.

2
This is your zone, in this instance it is Zone B.

Testing your APIs

To test your API, we recommend installing the free software called Postman, on which you can send your command using the above parameters to test if you get a response.

If the AudioFlow device responds as you expected then your API is working and you can proceed adding it into uOS.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing the correct switch.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling Shelly devices from uOS

This guide explains how to pull data from Shelly’s API so you can control it directly from uOS.

Shelly in uOS

Please note: this guide covers how to execute a command for a Shelly light, if you are using a different device the same logic applies, you only need to change the parameters. Please find the link to Shelly’s API document below for commands relating to different devices.

What this guide will cover:

  1. How to control Shelly lighting in your home.
  2. How to add that API into uOS.

Important: you must have the IP addresses first

There are a few ways you can get the IP address if your Shelly device:

  1. Use an mDNS discovery app like Fing to find Shelly on your network.
  2. Log into your wireless router and look for Shelly in the DHCP table.

What a typical Shelly command looks like

/color/0?turn=on&red=0&blue=0&green=255

This only shows the logic of a Shelly command, you may be controlling a relay and therefore need to use different parameters. There will be a link at the bottom which will take you to Shelly’s API documentation where you can find all their codes.

/color/0?
This is the mode of the device and declares it is an RGBW2 controller. If you were writing a command for an automated blind it would be /relay/0?.

turn=on
This affects the state of the device.

red=0&blue=0&green=255

Testing your APIs

You can test your Shelly command in the URL to see if it works. Make sure to include http:// for it to work properly.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing a light in the correct room and location.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling NETIO power switching from uOS

This guide explains how to control your NETIO PDU from uOS, uControl App and uControl Remote.

NETIO API

NETIO power switching in uOS

What this guide will cover:

  1. Understanding switching outputs, batches, ports and their status.
  2. How to create a NETIO API so that you can control power in the property.
  3. How to add that API into uOS.

Important: you must have the IP for NETIO first

You can get the IP address of your NETIO by:

  • Using an mDNS application like Fing on your mobile phone to scan your network.
  • Log into your wireless router and look up NETIO in the DHCP table.

For the purposes of this guide we are going to pretend that your NETIO PDU is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

NETIO ports are simple, port 1 is equal to 1 (p=1) and port 2 is equal to 2 (p=2) and so on. When typing your commands, make sure to follow this logic.

What a typical NETIO API looks like

http://192.168.1.15/netio.cgi?pass=1234abcd&output1=1

In the example above we are going to send a command to the Netio PDU (at 192.168.1.15) to execute a power switch turning output 1 to ON.

Understanding what those variables in the API above mean:

pass=1234abcd
This is the authentication and is user definable and can be changed to the name of the device owner on the NETIO web UI.

output=
This is the power output which allows you to set certain parameters:

  • 0 – Turn OFF
  • 1 – Turn ON
  • 2 – Short OFF delay (restart)
  • 3 – Short ON delay
  • 4 – Toggle (invert the state)
  • 5 – No change
  • 6 – Ignored

“&”
This sign allows you to add parameters to your command, every command must be linked by it.

Testing your APIs

We recommend that you test every API before you enter them into uOS. All IP based APIs have different requirements when it comes to testing but the NETIO API is great because it is super simple.

To test your API, open a web browser and enter the full API in the URL window and hit enter.

Screenshot-2023-05-12-121405

Testing your NETIO API is as easy as entering it into your favourite browser and hitting enter. If the NETIO device does what you expected it to then you’re good to enter it into uOS.

If the NETIO device responds as you expected then your API is working and you can proceed adding it into uOS.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing the correct PDU switch.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling Philips Hue lighting from uOS

This guide explains how to pull data from the Philips API so you can control it directly from uOS, uControl App and uControl Remote.

Philips Hue Lighting in uOS

What this guide will cover:

  1. How to gather information about your lights and use this to set their states.
  2. How to create a Philips Hue API so that you can control any light in the property.
  3. How to add that API into uOS

Important: you must have a developers account first

Before you can access the full Philips Hue API you must have made a Philips Hue Developer account.

Retrieving the IP address

There are a few ways you can get the IP address of your Philips Hue device:

  1. Use a network scanner app like Fing to find Philips Hue on your network.
  2. Use Philips Hue broker server discovery process.
  3. Log into your wireless router and look for Philips Hue in the DHCP table.
  4. The Philips Hue app – Start the Hue app and push link to connect to the bridge. Use the app to find the bridge and try controlling lights to ensure that everything is working. Then, go to the settings menu in the app, go to Hue Bridges, select your bridge and then the IP address of the bridge will be revealed.

Generating an access token

For the purposes of this guide we are going to pretend that your Philips Hue bridge is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

Firstly, we need to make an access token so you can make changes to the lighting.

To start this process, head over to the web browser API by typing in the command below with the IP address specific to your Philips Hue bridge.

http://192.168.1.15/debug/clip.html

Once loaded, you should see a grey “CLIP API Debugger” extension pop up, you then need to type /api/newdeveloper and click GET. You will get a reply in the command response which will state you’re an unauthorised user.

CLIP API

We now need to use the randomly generated username that the bridge creates for you. To incorporate this, do the following:

  1. Start off by typing /api into the URL.
  2. Then go ahead and type {"devicetype":"my_hue_app#iphone peter"} into the message body, we have used Peter as our example but your username will most likely be different so change it accordingly.
  3. Lastly, select your method as POST.
BRIDGE

After clicking POST you should get an error response telling you to press the link button, make sure to go press it on the bridge and then click POST again on the API. This is a security step which stops other people from accessing your lights.

You should then be given your access code which will look similar to the one below, make sure you hold onto this as it will be needed for all commands moving forward.

102ad6f46x253e821gcfr9ef1h07j10f

Now we have our acces token and you’re familiar with using the API, we can start controlling our lights. Watch the slideshow to see how to do execute different commands and what they do.

Testing your APIs

As Philips API commands require a command for the URL and also the message body, you will have to test if they’re working on the Clip API Debugger program. If they work, they are ready to be added into uOS!

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing a light in the correct room and location.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling GUDE power switching from uOS

This guide explains how to control your GUDE PDU from uOS, uControl App and uControl Remote. Here is a full overview of GUDE’s API.

Gude power switching in uOS

What this guide will cover:

  1. Understanding switching outputs, batches, ports and their status.
  2. How to create a GUDE API so that you can control power in the property.
  3. How to add that API into uOS.

Important: you must have the IP for GUDE first

You can get the IP address of your GUDE by:

  • Using an mDNS application like Fing on your mobile phone to scan your network.
  • Log into your wireless router and look up Gude in the DHCP table.

For the purposes of this guide we are going to pretend that your GUDE PDU is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

GUDEs ports are simple, port 1 is equal to 1 (p=1) and port 2 is equal to 2 (p=2) and so on. When typing your commands, make sure to follow this logic.

What a typical GUDE API looks like

http://user:secret@192.168.1.15/ov.html?cmd=1&p=1&s=1

The command above switches an output on or off (cmd=1). More specifically it switches/powers output 1 (p=1) on (s=1).

user:secret@
This is user definable and can be changed to the name of the device owner on the GUDE web UI.

Understanding what those numbers in the API above mean:

cmd=1, 2, 5, 12
This is the command which decides what kind of switch occurs:

  • cmd=1 switches the output.
  • cmd=2 cancels a batch switch.
  • cmd=5 starts a batch switch.
  • cmd=12 performs a reset.

p=1, 2 …, N
This is the number of the output which is being switched.

s=1
This is the state of the switch. 0 being off and 1 being on.

“&”
This sign allows you to add parameters to your command, every command must be linked by it.

How to Batch Switch using GUDE

Batch switching allows for multiple power outputs to be switched on or off simultaneously with a delay in between each switch if wanted. Below is an example of a batch switch, let’s break it down:

http://user:secret@192.168.1.15/ov.html?cmd=5&p=1&a1=0&a2=1&s=5

  • cmd is equal to 5 signifying a batch switch.
  • p is 1 so port number 1 will be switched.
  • a1 means action followed by a sequential number which increases with each additional action.
  • s in a batch switch is different to a normal switch. s is the delay in seconds between each action. As a defines whether an output is on or off a replaces s.

Testing your APIs

We recommend that you test every API before you enter them into uOS. All IP based APIs have different requirements when it comes to testing but the GUDE API is great because it is super simple.

To test your API, open a web browser and enter the full API in the URL window and hit enter.

Screenshot-2023-05-12-121405

Testing your GUDE API is as easy as entering it into your favourite browser and hitting enter. If the GUDE device does what you expected it to then you’re good to enter it into uOS.

If the GUDE device responds as you expected then your API is working and you can proceed adding it into uOS.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing the correct PDU switch.
  • Make sure that the structure of the API matches our example no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Controlling Rako scenes and lights from uOS

This guide explains how to pull data from Rako’s API so you can control it directly from uOS, uControl App and uControl Remote.

Rako Lighting in uOS

What this guide will cover:

  1. How to find room, channel, scene and level IDs in Rako’s API.
  2. How to create a Rako API so that you can control any light or scene in the property.
  3. How to add that API into uOS.

Important: you must setup Rako first

For the purposes of this guide we are going to assume that your Rako controller is on IP address 192.168.1.15 and your uOS device (MHUB, MZMA or Zone Processor) is on 192.168.1.196. We will use this to illustrate all examples moving forward.

Important: This guide assumes that you are familiar with Rako and know how to use Rasoft and that your Rako system is operational before integrating into uOS.

What a typical Rako API looks like

192.168.1.15/rako.cgi?room=5&ch=4&sc=0

In most cases you will either want to turn a light on/off or change the scene in any particular room. To do this you will need to send an API which looks like the example above.

In the example above we are going to send a command to the Rako controller (at 192.168.1.15) to execute a Scene 0 in Room 5 on Light 4.

Understanding what those numbers in the API above mean:

room=5
This is the ID of the room which your Rako devices are installed in.

ch=4
This is the channel which is how Rako refers to individual lights or RGB values.

sc=3
This is the scene ID.

“&”
This is a separator which is used to separate room, channel and scene values or IDs.

HELPFUL: Commonly used Scene IDs in Rako

  • Scene 0 = Off.
  • Scene 1-16 = Custom Scenes which you have made in Rako (lights at 10%, RGB value etc).

Testing your APIs

We recommend that you test every API before you enter them into uOS. All IP based APIs all have different requirements when it comes to testing but the Rako API is great because it is super simple.

To test your API, open a web browser and enter the full API in the URL window and hit enter.

Screenshot 2023-05-11 at 11.55.56

Testing your Rako API is as easy as entering it into your favourite browser and hitting enter. If the Rako device does what you expected it to then you’re good to enter it into uOS.

If the Rako device responds as you expected then your API is working and you can proceed adding it into uOS.

If it doesn’t work then try the following:

  • Make sure the IP address is correct.
  • Make sure that you do not have any typos.
  • Ensure that your IDs are correct and that you’re observing a light in the correct room and location.
  • Make sure that the structure of the API matches our example (no spaces, no special characters, data is in the correct case (often lowercase).

How to add your APIs into uControl

Need more help with the API? Get in touch.

All HDA staff are able to help with any API questions you might have including any advanced features. Get in touch for help or assistance.

Update MHUB or Zone Processor Firmware Utility

Please read the instructions (included in the .zip file) carefully before using this software.

In most cases the core system firmware for your device will not require updating. Most updates for uOS or MHUB-OS can be downloaded from our cloud via the uControl app. This update utility is designed to update low-level firmware and should be carried out carefully.

Download Update Utility

Please contact us to confirm if your system requires an update and to request your update file.