Big5 outputs are similar between the 5 supported protocols. That’s why we will cover them all here. Examples are for Serial RS232 Output. To choose another protocol just select it from the HS3 action drop down menu, where you’ll see them all
select the protocol you want to use and proceed with selecting the Big5 profile.
- Simple output.
You must setup Big5 profile before selecting any output/actions.
Simply enter the payload that you want Big5 to send out and click “Save”
The non visible characters are an important part for the serial communication. Use \r for CR and \n for LF.
Also there is no need for multiple HS3 actions if you want to send several messages one after another on the same profile. Line them up in the same action. You can also insert delays in ms
<wait 1000> will cause a delay of 1 second
You can use HS3 devices values within the output as well.
Example: “position=${val2011}” will send out “position=3” if the value of your HS3 device 2011 is 3.
2. Conditional output
Big5 supports conditional actions of the type.
If true do this else do that
This is significant because it saves a lot of time, effort and resources to setup multiple HS3 events triggered by conditions as HS3 does not support “If true do this else do that” format.
Example: (from real thermostat operations)
${ If( val1419 < val1411, “OpenRelay?Name=HVAC1,n=8,t=0,pp=test1” , “CloseRelay?Name=HVAC1,n=8,pp=test1”) }
This conditional action will open a relay if set temperature of the thermostat (hold by HS3 device 1419) is lower than the actual temperature (hold by HS3 device 1411) or else it will close the relay if this is not true.
Try to accomplish the same by HS3 means only.
Important: Please note that “…else do that” action can not be empty. Use “null” for no action like in the example below.
Example: (from real wind direction HS3 event)
${ If( val1978 < 22 or val1978 > 336, “North”,null) }
Training: Write a statement to send out this command (heat=1) to a pipe heater if temperature is below 32 F. Temperature is hold in HS3 device 123.
3. HTTP GET output
Effective version 1.26 and going forward the HTTP GET output is somewhat different than the older versions.
Put your main URL in the HTTP profile found in Big5 settings plus ${input} at the end like this
Example: http://www.for-example.com${input}
Put any additional strings in the Big5 HTTP action box (see p.1 and 2 above)
Example: ${ “?motorrpm=”+ val1944 + “/motordir=” + val1920 }
As a result the output that goes out looks like this assuming that HS3 devices have values of 200 and 0 respectively
Example: http://www.for-example.com?motorrpm=200&motordir=0
4. JSON output
If you are dealing with JSON API or REST API than setting up your HTTP profile is most important. Please note that you setup the header(s) and the parameter(s) in the profile not by output. Parameters are setup in the URL of the profile, while there is special box for headers.
Select the correct HTTP profile, Put your JSON file as a payload in the Big5 HTTP action and “save” it. That’s it. The JSON file will be send out (HTTP POST profile typically) each time the HS3 event containing this Big5 HTTP action is executed.