AQM Protocol - FORBIX SEMICON, Electronics products
Contents
1. Home Automation Control and Indoor Air Quality Monitor Command Set Oct 2014 FORBIX SEMICON Bangalore India Please feel free to give feedback through sales forbixindia com FORBIX SEMICON HAC AQM Command Set NOTICE FORBIX SEMICON reserves the right to make corrections modifications enhancements improvements and other changes to its products and services at any time and to discontinue any product or service without notice Customers should obtain the latest relevant information before placing orders and should verify that such information is current and complete All products are sold subject to FORBIX SEMICON s terms and conditions of sale supplied at the time of order acknowledgment Information contained in this publication regarding device applications is provided only for customer s convenience and may be superseded by updates It is solely customer s responsibility to ensure that the application meets the desired specifications To minimize the risks associated with customer products and applications customers should provide adequate design and operating safeguards FORBIX SEMICON MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WHETHER EXPRESS OR IMPLIED WRITTEN OR ORAL STATUTORY OR OTHERWISE RELATED TO THE INFORMATION INCLUDING BUT NOT LIMITED TO ITS CONDITION QUALITY PERFORMANCE MERCHANTABILITY OR FITNESS FOR PURPOSE FORBIX SEMICON does not warrant or represent that any license either expre2. E FORBIX SEMICON HAC AQM Command Set Example 8 To check the value of CO2 concentration from AQM Assume AQM address is 0xB782 Actual address in decimal is 46978 Port 0x03 CO2 sensor DataByte2 0x00 reserved DataByte3 0x00 reserved Channel number 0x25 Actual channel number is decimal 37 fbx p B78203000025 W or Ox66 0x62 0x78 Ox5F 0x70 Ox5F 0x42 0x37 0x38 0x32 0x30 0x33 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD or fbx p b78203000025 W or Ox66 0x62 0x78 Ox5F 0x70 Ox5F 0x62 0x37 0x38 0x32 0x30 0x33 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD In response to this the master will send back SB7820301E7 r_ incase of success this means temperature is 487ppm 487 decimal is OXO1E7 or f878203W incase of failure Example 9 To check the value of HCHO Formaldehyde concentration from AQM Assume AQM address is 0xB782 Actual address in decimal is 46978 Port 0x05 HCHO sensor DataByte2 0x00 reserved DataByte3 0x00 reserved Channel number 0x25 Actual channel number is decimal 37 fbx p B78205000025 W or Ox66 0x62 0x78 Ox5F 0x70 Ox5F 0x42 0x37 0x38 0x32 0x30 0x35 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD or fbx p b78205000025 Wr or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x62 0x37 0x38 0x32 0x30 0x35 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD In response to this the master will send back sB782050004Wr incase of success this means temperature is 0 04ppm or fB78205 r incase of failure es
3. 30 FORBIX SEMICON 2 HAC AQM Command Set fbx t orfbx p or r s or f or e Internal Architecture NW TODO for HAC B TODO for AQM B Range of communication The range of wireless system is within 30 50 meters in indoor conditions and around 100 150 meters in open line of sight conditions It is suggested to keep the machine away from vicinity of metals concrete structures wood and water for better range of communication Radio machines can also interact with our repeater systems for improved performance in communication range It is always suggested to keep all FORBIX SEMICON radio machines upright antenna pointing towards the sky For both FBXHAC Wireless HAC Driver Communication AQM Sensor and FBXAQM machines the antenna is vertically mounted FBXAQM machines are fit to be used ONLY for indoor purposes Do not expose to acidic and oily environments Exposing to places that might exceed specified values of temperature humidity or VOC gases might damage the internal sensor operation Details of FBXAQM models are available as a part of specification document 12 Page FORBIX SEMICON HAC AQM Command Set Use for the intend purpose The equipment device module may only be used for the application cases specified in the Catalogue and the user manual and only in connection with devices and components recommended and approved by FORBIX SEMICON FORBIX SEMICON machines sho
4. is 42290 Port 0x05 5 port Assume port is presently ON user cannot drive these bits as it will contain the status DataHigh 0x00 0x0x01 0x02 to 0x09 OxOA OxFF valid values DataLow 0x00 12 levels of dimming control 0x00 0x01 0x02 0x03 0x04 OxFF Channel number 0x12 Actual channel number is decimal 18 fbx p A53205010012 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x41 0x35 0x33 0x32 0x30 0x35 0x30 0x31 0x30 0x30 0x31 0x32 Ox5F OxOD or fbx p 353205010012 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x61 0x35 0x33 0x32 0x30 0x35 0x30 0x31 0x30 0x30 0x31 0x32 Ox5F OxOD In response to this the master will send back SA532050100W incase of success or fA53205W incase of failure Example 5 To drive PWM intermediate value to a port value connected to HAC driver Assume FBXHACO1 address is 0xA532 Actual address in decimal is 42290 Port 0x05 5 port Assume port is presently ON user cannot drive these bits as it will contain the status DataHigh 0x00 to OxFF DataLow 0x01 All 255 values 0x00 to OxFF Channel number 0x12 Actual channel number is decimal 18 fbx p A53205020112 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x41 0x35 0x33 0x32 0x30 0x35 0x30 0x32 0x30 0x31 0x31 0x32 Ox5F OxOD or fbx p 253205020112 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x61 0x35 0x33 0x32 0x30 0x35 0x30 0x32 0x30 0x31 0x31 0x32 Ox5F OxOD In response to this the master will send back SA532050201W incase of success or fA53205 r_ i
5. FE Indicates individual driver port HAC slave driver OxFF Indicates all ports HAC slave driver OxFF is not valid for AQM 0x01 Temperature Sensor AQM sensors 0x02 Humidity Sensor AQM sensors 0x03 CO2 Carbondioxide Sensor AQM sensors 0x04 CO Carbon mono oxide Sensor AQM sensors 0x05 HCHO Formaldehyde Sensor AQM sensors 0x06 C6H6 Benzene Sensor AQM sensors 0x07 Toluene Sensor AQM sensors 0x08 H2S Hydrogen Sulphide Sensor AQM sensors 0x09 Alcohol Sensor AQM sensors Ox0A LPG Sensor AQM sensors e Formaldehyde HCHO gas concentration is in decimal value which is represented by databyte2 and databyte 3 Example Formaldehyde value is 0 02ppm then databyte2 0x00 and databyte3 0x02 If concentration is 0 20 then databyte2 0x00 and databyte3 0x14 hex value of 20 Similarly for concentration is 12 53 then databyte2 OxOC and databyte3 0x35 hex value of 53 e For other gases concentration is directly mapped to 2 data bytes Example for CO2 concentration is 495ppm OxO1EF databyte2 0x01 and databyte3 OxEF e For temperature and humidity databyte2 contains the hex value and databyte3 0x00 es rae FORBIX SEMICON HAC AQM Command Set Examples Example 1 To drive a port ON this will make an electrical appliance connected to a HAC driver ON Assume FBXHACO1 address is 0xA532 Actual address in decimal is 42290 Port 0x05 5 port ON OxFF DataByte3 0x00 reserved Channel number 0x12 A
6. arity None Data bits 8 Stop bit 1 Handshake None Commands from user to master for slave unit are of 20 byte format ascii values for each encoded value 4 Page FORBIX SEMICON 2 HAC AQM Command Set Command Format from user to master fbx Cmd Addr Addr MSB LSB Port Data Data Channel _ OxOD Number High Low 4 bytes 1byte Preamble fbx 0x66 0x62 0x78 Ox5F See Note below for the preamble explanation Cmd t 0x74 Ox5F Transmit command to control the slave unit p 0x70 Ox5F Ping command to query or get status from the slave unit Addr 0x00 to OxFF Address of the HAC AOM slave unit see examples The address needs to fed in using ascii characters ONLY Port number 0x00 to OxFF For HAC Individual port numbers for electrical appliances For AQM Port number is the sensor value see Note t Data High 0x00 to OxFF For HAC 0x00 port to turn OFF OxFF port to turn ON for other valuesintermediate value for dimming control see example For AQM Not Applicable NA OxOO this field is NOT checked by the master Data Low 0x00 to OxFF For HAC Reserved not used at present For AQM Not Applicable NA 0x00 this field is NOT checked by the master Channel 0x00 to OxFF Operating channel frequency of the master to slave interaction This field is internally decoded for data encryption for sending data 0x0D 0x0D Trailer closing command hard code
7. ctual channel number is decimal 18 Command from the user to the master can be either of the following fbx t A53205FF0012 W or 0x66 0x62 0x78 Ox5F 0x74 Ox5F 0x41 0x35 0x33 0x32 0x30 0x35 0x46 0x46 0x30 0x30 0x31 0x32 Ox5F OxOD or fbx t a53205ff0012 Wr or 0x66 0x62 0x78 Ox5F 0x74 Ox5F 0x61 0x35 0x33 0x32 0x30 0x35 Ox66 0x66 0x30 0x30 0x31 0x32 Ox5F OxOD Example 2 To check ping get status of the port value of electrical appliance connected to HAC driver Assume FBXHACO1 address is 0xA532 Actual address in decimal is 42290 Port 0x05 5 port Assume port is presently ON user cannot drive these bits as it will contain the status DataByte3 0x00 reserved Channel number 0x12 Actual channel number is decimal 18 fbx p A53205000012 W or Ox66 0x62 0x78 Ox5F 0x70 Ox5F 0x41 0x35 0x33 0x32 0x30 0x35 0x30 0x30 0x30 0x30 0x31 0x32 Ox5F OxOD or fbx p 353205000012 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x61 0x35 0x33 0x32 0x30 0x35 0x30 0x30 0x30 0x30 0x31 0x32 Ox5F OxOD In response to this the master will send back SA53205FFOO r incase of success or fA53205 r incase of failure Example 3 To bring back the master to IDLE state and stop and transmission or reception r In response to this the master will send back e es ara FORBIX SEMICON HAC AQM Command Set Example 4 To drive PWM intermediate value to a port value connected to HAC driver Assume FBXHACO1 address is 0xA532 Actual address in decimal
8. d to 0x0D Master can also receive M or OxOD as a reset command to immediately stop radio transactions following to which the master responds back with e or 0x065 5 Page FORBIX SEMICON HAC AQM Command Set Command Format from master to user Preamble Addr Addr Data Data Data Channel M OxOD MSB LSB Byte1 Byte2 Byte3 Preamble 0x73 Success with all the trailing fields 0x66 Failure without fields DataByte2 DataByte3 Channel and _ 0x65 Echo without any other trailing field Addr 0x00 to OxFF Address of the HAC AOM slave unit see examples The address needs to fed in using ascii characters ONLY Addr 0x00 to OxFF Address of the HAC AOM slave unit see examples The address needs to fed in using ascii characters ONLY Port number 0x00 to OxFF For HAC Individual port numbers for electrical appliances For AQM Port number is the sensor value see Note t Data High 0x00 to OxFF For HAC 0x00 indicating port is OFF OxFF indicating port is ON for other values intermediate value indicates dimmed value of the port see example For AQM This field contains the sensor value MSB side Data Low 0x00 to OxFF For HAC Reserved not used at present For AQM This field contains the sensor value LSB side Channel 0x00 to OxFF Operating channel frequency of the master to slave interaction This field is internally decoded for data encryption for sending data 0x0D 0x0D Trailer cl
9. ncase of failure rare FORBIX SEMICON HAC AQM Command Set Example 6 To check the value of temperature from AQM Assume AQM address is 0xB782 Actual address in decimal is 46978 Port 0x01 Temperature sensor DataByte2 0x00 reserved DataByte3 0x00 reserved Channel number 0x25 Actual channel number is decimal 37 fbx p B78201000025 W or Ox66 0x62 0x78 Ox5F 0x70 Ox5F 0x42 0x37 0x38 0x32 0x30 0x31 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD or fbx p b78201000025 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x62 0x37 0x38 0x32 0x30 0x31 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD In response to this the master will send back B782011600 r_ incase of success this means temperature is 22 00 C 22 decimal is 0x16 or fB78205W incase of failure Example 7 To check the value of humidity from AQM Assume AQM address is 0xB782 Actual address in decimal is 46978 Port 0x02 Humidity sensor DataByte2 0x00 reserved DataByte3 0x00 reserved Channel number 0x25 Actual channel number is decimal 37 fbx p B78202000025 W or 0x66 0x62 0x78 Ox5F 0x70 Ox5F 0x42 0x37 0x38 0x32 0x30 0x32 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD or fbx p b78202000025 Wr or Ox66 0x62 0x78 Ox5F 0x70 Ox5F 0x62 0x37 0x38 0x32 0x30 0x32 0x30 0x30 0x30 0x30 0x32 0x35 Ox5F OxOD In response to this the master will send back sB782022D00W incase of success this means temperature is 45 rH 45 decimal is OX2D or fB78202 r incase of failure
10. osing command hard coded to 0x0D 6 Page FORBIX SEMICON HAC AQM Command Set Notes Preamble fbx is the header of the packet format that enters the master module There is a large amount of uncontrollable data that enters the master unit when connected to a WiFi router or gateway FBXGWO 1 To filter out the data appropriately this preamble word is needed s success This is response from the HAC or AOM slave machines to the master controller on account of successful acceptance of data packets f failure This is the response from HAC or AQM slave machines to the master or from master to the user that the t or p command was not executed Failure in response can happened because of any of the following 3 reasons 1 Slave unit HAC or AOM is out of reach out of range of radio communication 2 Slave unit HAC or AOM is switched OFF radio controller is power down 3 Hardware malfunction in the sensor or driver ports e echo This is in response of r or OxOD or carriage return Echo responding indicates that the machines is active and can respond back to the user It also resets the radio controller and frees it immediately from any of the presently occupied activity viz transmission reception or sensor calculation DataByte 1 Port number The port number can be anywhere from 0x00 to OxFF for HAC driver ports Value Description Destination 0x00 Ox
11. s 1 FBXUFO1 This is the computer interfacing hardware USB based that can accept commands from users In this document this unit is mentioned as Master at many places 2 FBXHACO1 This is the driver unit for home automation electrical appliances It has driving ports that controls the electrical loads directly In this document this unit us mentioned as Slave driver or Slave HAC at many places 3 FBXAOM These are sensor modules that are used for air quality monitoring and other household gas monitoring In this document this unit is mentioned as Slave AQM at many places 4 FBXGWO I This is a bridge unit between Wiil and wireless devices The master unit FBXUFO1 connects to the computer or PC via a USB A to B cable and logically operates on the COM port of the computer It is basically a serial data interface The master machine can also be connected by a USB master controller or any other computer alike system that enable to operate serial communication over USB port Practically the master controller can communicate with any number of slave unit HAC or AQM machines The interface protocol consists of two types of transactions e Command from master to slave this is same as commands from user to master e Command from slave to master this is same as commands from master to user Technical details of the serial interface e Baud 9600 or 115200 depending on factory settings P
12. severe personal injury or death Buyers represent that they have all necessary expertise in the safety and regulatory ramifications of their applications and acknowledge and agree that they are solely responsible for all legal regulatory and safety related requirements concerning their products and any use of FORBIX SEMICON products in such safety critical applications Further Buyers must fully indemnify FORBIX SEMICON and its representatives against any damages arising out of the use of FORBIX SEMICON products in such safety critical applications FORBIX SEMICON products are neither designed nor intended for use in military aerospace applications Buyers acknowledge and agree that any such use of FORBIX SEMICON products is solely at the Buyer s risk and that they are solely responsible for compliance with all legal and regulatory requirements in connection with such use EENENENEANO o0 FORBIX SEMICON HAC AQM Command Set FBXUFO1 Command Set for FBXHAC Home Automation Control and AOM Air Quality Monitor TODO EE 0 FORBIX SEMICON 2 HAC AQM Command Set Introduction This document provides the detailed information of the protocol interface for all home automation control HAC and indoor air quality monitor AQM products This command set is a common interface that interacts between machine to machine to send and receive commands from a distant location The whole setup comprises of 4 section
13. ss or implied is granted under any FORBIX SEMICON copyright mask work right or other FORBIX SEMICON s intellectual property right relating to any combination machine or process in which FORBIX SEMICON products or services are used Information published by FORBIX SEMICON regarding third party products or services does not constitute a license from FORBIX SEMICON to use such products or services or a warranty or endorsement thereof Reproduction of FORBIX SEMICON information in FORBIX SEMICON data books or data sheets is permissible only if reproduction is without alteration and is accompanied by all associated warranties conditions limitations and notices Reproduction of this information with alteration is an unfair and deceptive business practice FORBIX SEMICON is not responsible or liable for such altered documentation Information of third parties may be subject to additional restrictions Resale of FORBIX SEMICON products or services with statements different from or beyond the parameters stated by FORBIX SEMICON for that product or service voids all express and any implied warranties for the associated FORBIX SEMICON product or service and is an unfair and deceptive business practice FORBIX SEMICON is not responsible or liable for any such statements FORBIX SEMICON products are not authorized for use in safety critical applications such as life support where a failure of the FORBIX SEMICON product would reasonably be expected to cause
14. uld NOT be opened without prior permission from the manufacturer Warranty void otherwise Exclusion of liability We have checked the contents of this publication and every effort has been made to ensure that the descriptions are as accurate as possible However deviations from the description cannot be completely ruled out so that no liability can be accepted for any errors or omissions in the information given The data in this manual is checked regularly and the necessary corrections will be included in subsequent editions If you have any suggestions please let us know via email at sales forbixindia com 9 Document History Revision Date Approved Description Changes Aug 2014 Yes Initial Release pending TODO items Oct 2014 Yes Modified AQM sensor values and examples sr
Download Pdf Manuals
Related Search