Honeywell ISA100 Gen X User Manual

Radio module
Table of Contents

Advertisement

Quick Links

ISA100 Gen X Radio Module
User's Guide
Release Independent
April 2018
Honeywell

Advertisement

Table of Contents
loading

Summary of Contents for Honeywell ISA100 Gen X

  • Page 1 ISA100 Gen X Radio Module User's Guide Release Independent April 2018 Honeywell...
  • Page 2 Release Information Document Name Version No. Release Number Publication Date ISA100 Gen X Radio Module User's Guide Release Independent April 2018 Contact Information Contact: Honeywell Technology Solutions Lab ACS Wireless COE Survey No. 19/2 Adarsh Prime Project Pvt. Ltd Devarabisanahalli,...
  • Page 3 Application Process Data Unit RSSI Received Signal Strength Indicator RSQI Received Signal Quality Indicator EEPROM Electrically Erasable Programmable Read Only Memory Liquid Crystal Display GPIO General Purpose Input Output Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 4 Upload Download Object Low Power Mode Cyclic Redundancy Code Physical Data Link layer Service Access Point Network Layer Transport Layer Data Process Object Data Management Object International Society of Automation Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 5: Table Of Contents

    6.1 Start-up Mode ............................... 45 6.2 Normal Mode ..............................45 SAMPLE CODE DESCRIPTION ..................47 7.1 Scheduler ..............................47 7.2 Interrupts ..............................47 7.3 ISA100 Objects ............................. 48 Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 6 Software Compliance ..........................65 APPENDIX B: AGENCY LABEL INFORMATION ............. 66 FCC/IC Labels ............................66 APPENDIX C: PROGRAMMING GXRM................68 C.1 Introduction ..............................68 C.2 Software Configuration ..........................68 Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 7 Table 5 Stack Specific Packet Types ......................34 Table 6 Five Objects of the Sensor Firmware ..................... 48 Table 7 Detailed Device Status ........................51 Table 8 Antenna and power level Settings FCC………………..………………………………………….61 Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 8 Figure 13: Mechanical Drawing of ISA 100(2) ................60 Figure 14: J-Flash tool device selection ..................69 Figure 15: J-Flash tool data file selection ................... 70 Figure 16: J-Flash tool device programming…………………………........71 viii Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 9 Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 10: Introduction

    Hardware Module is 2.4GHz band, 802.15.4 Radio based hardware, and can host multiple software protocol stacks like ISA100, zigbee™, 802.15.4, and WirelessHART™. Figure 1: ISA100 Radio Board Block Diagram - Major Components Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 11 REFERENCE - INTERNAL: For Compliance Statements, refer to Appendix A: Compliance Statements For Agency Label Information, refer to Appendix B: Agency Label Information Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 12: Specifications

    The modular certification is performed for the antenna types (Refer to Table 1 Antenna Types). The certification is void if you use any other antennas than the ones mentioned in the table. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 13: Table 1 Antenna Types

    Antenna gain Power level settings Centurion MAF94152 Omni Antenna L-COM HG2402RDR-RSP "Rubber-Duck"Omni Antenna EM wave EM-B14503-MMP- L-COM HGV-2404U Omni Antenna L-COM HGV-2409U Omni Antenna L-COM HG-2414D remote Dish Antenna Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 14: Transmitter Power Configuration

    Radio board. Table 2 Transmit Power Settings S No. Power Level 20dBm 19dBm 18dBm 17dBm 15dBm 14dBm 12dBm 11dBm 10dBm 6dBm 4dBm 3dBm 1dBm 0dBm -1dBm -5dBm Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 15: Connector Details

    Debug Connector Pin Details Figure 2: Debug connector pin details SWS_DIO: data input/output SWD_CLK: input clock VCC: The operating voltage ranges from 2.7 Volts to 3.6 Volts. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 16: Figure 3: Connecting Debug Connector With J-Link Connector

    Connecting the Debug Connector to J-Link JTAG Connector The following diagram explains the connection details of the Debug Connector to J-Link JTAG Connector. Figure 3: Connecting Debug Connector with J-LINK Connector Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 17: Figure 4: Debug Connector Pin Marking

    Figure 4: Debug Connector Pin Marking Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 18: Figure 5: Fet And Radio Board Connection

    Figure 5: FET and Radio Board Connection Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 19: Sensor-Radio Interface Connector Details

    Sensor, whereas GPIO is used as General Purpose Input/output as well as interruptible configurable pin. Note: GPIO_02 pin in the Sensor-Radio interface connector is used as Sensor Data Ready interrupts (SDR).GPIO_01 is the inverse of Chip Select(SPI_CS). Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 20: Figure 6: Sensor-Radio Interface Connector

    Figure 6: Sensor-Radio Interface Connector Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 21: Table 3 Pin Details Of Radio Sensor Interface Connector

    The following table provides the Pin details of the Radio-Sensor interface connector. Table 3 Pin Details of Radio Sensor Interface Connector GPIO_01(SPI_CS) GPIO_02 (SDR) SPI_CLK SPI_MISO SPI_MOSI SPI_CS Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 22: Architectural Overview

    The ISA100 Gen X Radio Board implements the Device Manager (DMAP), ASLDE0 SAP, and TDSAP-0 and all the other subsequent layers. The Sensor processor board implements the User Application Process n (n = 2, 3, 4…15) and the equivalent ASLDE- n SAP and TDSAP-n.
  • Page 23: Figure 7: Isa100 Device Architecture

    Figure 7: ISA100 Device Architecture Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 24: Spi Communication Between The Isa100 Radio And The Sensor Board

    An ISA100 packet transferred over the SPI is directed to the ISA100 application layer to be parsed and transferred to a local object or routed to a network or IR port. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 25: Figure 8: Spi Communication Signals

    SPI is in an idle state. Radio places a fixed 10 msec delay between the packets to guarantee that the Sensor is ready for the next packet. Figure 8: SPI Communication Signals Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 26 Tx buffer. The SPI Tx data interrupt is not required to allow a faster and lower power interface. As the SPI is buffered twice, this mechanism allows the SPI data to be transferred as a continuous bit stream. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 27: Inter-Processor Interface

    Sensor – Radio inter-processor communications. These stack management functions are provided for the use of a packet class header byte that directs the packet to stack management access interface. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 28: Inter Processor Communication Packet Description

    Sensor board using the Sensor select line. This select line indicates the start of a packet transfer to the Sensor. The Sensor then loads a 5A sync byte into the transmit Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 29 The Request-Response bit is used only for Stack specific Class packets. ASL queued packets class = 0x00 Stack specific class = 0x30 (Request) or 0x38 (Response) Packet Type Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 30 Tx and Rx buffers are implemented and no ASL queue is implemented in the Sensor. In addition, ASL queue packets allow coordination of notification for contract errors as well as network retry. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 31: Figure 10: Sensor Board Integration With Rf Modem Using Isa100/Full Api

    ID and, if valid, sends the packet down the stack to be transmitted on the wireless network. If the contract ID of an ASL APDU request is set to Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 32: Figure 11: Sensor Packets Logical Reference Model

    ASL indication and it is sent to the Sensor board when it acquires its priority APDU. ASL Queued Packet Types The ASL queued class of packets supports three packet types: Request, Confirm, and Indication. Figure 11: Sensor packets Logical Reference Model Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 33: Table 4 Asl Queued Packet Types

    ASL Data Indication A Data Indication Packet indicates to the Sensor application process that an application data packet has been received. Local indications sent from the Radio board either is Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 34: Table 5 Stack Specific Packet Types

    ISA100_NOTIFY_ADD_CONTRACT Notification from DMO of new contract ISA100_NOTIFY_DELETE_CONTRACT Notification from DMO of deleted contract ISA100_CONTRACT_TERMINATE Notification from DMO to terminate contract ISA100_NOTIFY_JOIN Notification of change in Join Status Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 35 Sync Packe Packe Packe Packe Packe Checksum Checksu t ID t size m MSB Byte Lengt Class Type 0x5A 0x04 0x30 0x1C 0x9C 0x00 Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 36 Radio. The Radio sends a response to the Sensor with the current join status. The request message has a data length of 0, whereas the response message has a 1- byte data value of join status. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 37 1-byte join status in the data portion. There is no response message for this. Sync Packet Packet Packet Packet Packet Data Check Check Byte Length Class Type size Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 38 Sensor sends UAP Status: Synch Packet Packet Packet Packet Packet Data Bytes Checksum Checksum Byte Length Class Type size 0x5A 0x08 0x30 0x81 0x01 0x04 Descriptio n below Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 39 0x0f 0x01 0x0A 6 bytes Rsrvd of TAI time ISA100_GET_TAI_TIME Sensor can request for TAI time if required. Usually the radio sends the TAI time every 20 seconds. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 40 Sync Byte Packe Packe Packe Packe Packe Checksu Checksu t ID t size m LSB m MSB Lengt Class Type 0x5A 0x06 0x38 0x97 0x01 0x02 RSSI RSQI Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 41 Data35,Data36 Contract Contra Contract BW Period ct BW BW Phase Deadline Aperiodic Contract Request Data32,Data 31 Data34,Data35 Data36 Contract BW Contract BW Contract commit Burst Excess Burst Window Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 42 Periodic Contract Data13,Data14 Data15 Data16,17 Contract BW Period Contract Contract BW Deadline BW Phase Aperiodic Contract Data13,Data14 Data15,Data16 Data17 Contract BW Contract Contract BW Commit Burst Window Excess Burst Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 43 (communication, process, device diagnostics, and security). The 1- byte data value carries the alarm category. Synch Byte Packet Packet Packet Packet Packet Data0 Check Check Length Class Type size 0x5A 0x05 0x38 0x8C 0x01 0x01 Alert Category Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 44 Byte 0 Byte3 Byte4 Byte4 Byte5 Byte6 Byte7 Byte8-ByteN Byte 2 UAP ID SOID Alert Alert Aler Alert Alert Alert value length Alert Value Class Directio Priorit Categor Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 45: Message Flow Between The Radio And Sensor

    The Radio also keeps the Sensor notifying the TAI time every 20 seconds and the RSSI and RSQI values every 1 minute. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 46 ISA100_NOTIFY_ALARM_REGEN_BEGIN if necessary, and the Sensor is expected to send all the active alarms. When all the alarm information is sent, it has to send an alarm regeneration end message, ISA100_NOTIFY_ALARM_REGEN_END. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 47: Sample Code Description

    Occurs every 250 msec SPI chip select interrupt Selects the Sensor for SPI transmission SPI Receive Interrupt On reception of a Data Byte IR Interrupt IR reception or time outs Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 48: Isa100 Objects

    Activate, delete, and terminate contracts AI Object Functions for  AI initializations  read AI attributes  Write to AI attributes  Execute requests and assemble data to be published Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 49: Device Drivers

    Handles IR initializations, IR interrupts, receive and transmit processing EEPROM Functions for EEPROM read, write, compare, unprotect, and driver read status LCD Driver Functions for LCD init string display, Display for RSSI and RSQI Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 50: Alert Configuration And Reporting

    All the device diagnostic errors are classified into four categories: Maintenance Alert Out Of Spec Alert Function Check Alert Failure Status Alert. Table 7 describes how the detailed device status gets mapped into four Broad Alert types. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 51: Table 7 Detailed Device Status

    DEV_ST_CHAR_FAUL DEV_ST_EXCESS_ZER INSTALLATION_CALIBRATION_PR OBLEM DEV_ST_EXCESS_SPA out_of_spec_alert_desc (106) DEV_ST_EXCESS_CAL DEV_ST_M OUTSIDE_SENSOR_LIMITS B_OVT DEV_ST_M B_OVL ENVIRON_CONDITIONS_OUT_OF_ None SPEC DEV_ST_LOW_B POWER_CRITICALLY_LOW DEV_ST_LOW_E XT_PWR maintenance_alert_desc (105) FAULT_PREDICTED None POWER_LOW None SENSOR_MAINTAINACE_REQUIRE None Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 52 For Example, when FAULT_IN_ELECTRONICS bit is set in the UAPMO.DEVICE_STATUS attribute, the particulars about the Electronics fault (ROM, RAM, or NVM failure and so on) are given in the APMO.DEVICE_STATUS_DETAIL attribute. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 53 When the device joins the network, the function uapmo_alert() function checks if the corresponding alert is enabled or disabled by checking the uapmo_param_desc descriptor Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 54 Sensor board and the security and communication alerts are handled or generated by the Radio. Alert Direction is used for alarm to indicate alarm occurrence or return of the alarm to normal condition. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 55 A total of 10 bits is transmitted for a byte. Start bit is always 0 and the Stop bit is 1. “0” is represented by a pulse of the duty cycle 3/16 and “1” is represented by the absence of a pulse. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 56 Prior to the device joining the network, only the firmware version and the join status is displayed. The function “display_task()” is called every 1 second from the main loop. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 57 UDO variable state accordingly. Currently, no checks are implemented for EEPROM write and the data that is downloaded through the bin file is written from EEPROM address 0x1100 onwards. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 58 The current code does not support the writing of the software into the flash. The function “udo_get_param_info” is called following a read request and it returns the value of the UDO parameter for which the request is issued. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 59: Mechanical Drawing Of Isa100 Radio Module

    8. Mechanical drawing of ISA100 Radio Module Figures 10 and 11 explains the mechanical drawing of ISA100 Radio Module. Figure 12: Mechanical Drawing of ISA 100(1) Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 60: Figure 13: Mechanical Drawing Of Isa 100(2)

    Figure 13: Mechanical Drawing of ISA 100(2) Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 61: Power Level Settings For Fcc And Ic

    L-COM HG2402RDR-RSP "Rubber-Duck"Omni Antenna EM wave EM-B14503-MMP- L-COM HGV-2404U Omni Antenna L-COM HGV-2409U Omni Antenna L-COM HG-2414D remote Dish Antenna Table 9: Antenna and power level settings FCC Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 62: Appendix A: Compliance Statements

    — Consult the dealer or an experienced radio/TV technician for help Changes or modifications to this equipment not expressly approved by Honeywell International INC may void the user's authority to operate this equipment.
  • Page 63: Ic Compliance Statements

    WILL VERIFY that the product is incorporated in host equipment in a way that is represented by the testing as shown in the test report. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 64 This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to ISED Part ICES-003 Rules. LIST OF APPROVED ANTENNAE To know the recommended Antennae and their respective power level settings, please refer Table 9. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 65: Software Compliance

    The ISA100 field device software stack running in the Gen X Radio board is certified by the WCI (Wireless Compliance Institute) to be in compliant with 2009 version of ISA100 specification standard. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 66: Appendix B: Agency Label Information

    IC : 573W -51494541  HVIN : 51454941 - 001 Label Location in GXRM and HOST Label diagram: Label Location: The Label is pasted on the backside of the board. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 67 Label Diagram for Host: Label Location diagram: Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 68: Appendix C: Programming Gxrm

    This section gives information on what configuration need to be used in the tool to flash the image. After installing the software, the following steps are to be followed to configure the device. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 69: Figure 14:J-Flash Tool Device Selection

    Step 1: Open the J-Flash lite tool, and select the mentioned options as in the image below Figure 14:J-Flash tool device selection Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 70: Figure 15:J-Flash Tool Data File Selection

    Step 2: After configuring the device select the HEX file that must be flashed, in the data file section Figure 15:J-Flash tool data file selection Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...
  • Page 71: Figure 16: J-Flash Tool Device Programming

    After selecting the HEX file, click on Program Device option. The program will be flashed to the device. Figure 16: J-Flash tool device programming Once the device has been flashed with the firmware the “Programming done” will be displayed in the Log section. Release Independent ISA100 Gen X Radio Module User's Guide April 2018 Honeywell...

Table of Contents