Controlling AudioFlow from uOS
This guide explains how to control your AudioFlow switch from uOS.
What this guide will cover:
- Understanding switching outputs.
- How to create an AudioFlow API so that you can control your speakers in the property.
- 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.
What a typical AudioFLow API looks like
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:
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.
This specifies which audio zones you are switching. If you don’t include the zone number, your payload will trigger all zones.
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.