Dual Channel Analog Data End Device Developer Guide

Transcription

1 Dual Channel Analog Data End Device Developer Guide Revision E

2 Preface Notice Copyright 2011 Inovonics Inovonics intends this manual for use by Inovonics customers only. All comments concerning the contents of this manual should be directed to the Inovonics marketing department. No part of this work covered by copyright may be reproduced in any form either graphically, electronically or mechanically; including photocopying, recording, taping, or storing in an information retrieval system without prior written permission from Inovonics. Note: Features and capabilities marked Future in this document are not implemented in current products. These capabilities are included for your application planning and design. Trademarks Inovonics and EchoStream are registered trademarks of Inovonics. All other brand names and product names used in this manual are trademarks, registered trademarks, or trade names of their respective holders. Technical Services Contact Information For Inovonics technical services: Phone: (800) ; (303) Revision E 2

3 Document Conventions The following notices are used throughout this document: Note: Emphasizes points, provides supplementary information, or indicates minor problems in an expected outcome. Caution:Indicates possible damage to equipment or loss of data, as well as potential problems in an expected outcome. Warning:Indicates the possibility of minor injury to oneself or others. Danger:Indicates the possibility of serious or fatal injury to oneself or others. Revision History Revision Level C D Revision Description Edited cover and made changes to paragraph styles; edited to remove legacy ES1702 information and added to EN1702 and EE1702; edited product overview Minor copy edits E Edited high value limit from 4.1mA to 20.1mA in section , Valid Ranges on page 10. Revision E 3

4 Table of Contents Preface 2 Notice... 2 Trademarks... 2 Technical Services Contact Information... 2 Document Conventions... 3 Revision History... 3 Chapter 1 Overview Introduction Product Information...6 Chapter 2 Registration Registration Overview Registration Procedure from the End User s Perspective Registration Procedure from the Developer s Perspective Device Reset, Application Controller Not in Registration Mode Removing a Registered Device from the System... 9 Chapter 3 Message Information Analog Data Message Measurement Value Valid Range Valid Ranges Message Formats Two Analog Measurements without Options Two Analog Measurements with Options Product Type Identifiers for EchoStream Devices Product Naming Conventions...14 Revision E 4

5 3.2.2 EchoStream Device Identifiers Table...14 Chapter 4 Programming Program the Dual Analog End Device Create a Programming Device Programming Cable Programming Device Timing Requirements Dual Analog End Device Programming Commands x01 Write Options x08 Read Options x0E Read First External Sensor x0F Read Second External Sensor...20 Revision E 5

6 Chapter 1 Overview 1.1 Introduction The Inovonics dual analog input wireless end device supports user-selectable dual channel input on a single device. One or two sensors using the same measurement units can be attached to measure two conditions at the same location. The EE1702 is configured for use in Europe; the EN1702 is for use in North America, Australia, and New Zealand Product Information Revision E 6

7 Chapter 2 Registration 2.1 Registration Overview Every device is programmed with a four-byte unique identification (UID) number. The UID is sent with every message, indicating the device which transmitted it. The UID is made up of a one-byte market identification (MID) number and a three-byte serial number. The bar code label on each printed circuit board includes the eight digit serial number. For example the bar code label B-1 begins with the eight-digit serial number: Converting this number to hexadecimal yields: 0F Preceding this serial number with the MID (B2, the MID for security devices, for example) gives the UID: B2 0F 20 08, and will appear in every RF message sent by the device. The purpose of registration is to associate the unique ID in the wireless device with specific application functionality, such a descriptive name, the location and point supervision. It is recommended that all wireless transmitters, transceivers and repeaters be registered. To ensure wireless devices are registered only when intended, the application controller should have a specific registration mode. 2.2 Registration Procedure from the End User s Perspective 1. The application controller is placed in registration mode, ready to associate the device s UID with application functionality. 2. The application controller prompts the end user to enter application specific information and send a registration message from the device. Revision E 7

8 Registration 3. The application controller receives the registration message, associates the device s UID with appropriate application information, and lets the end user know registration was successful. 2.3 Registration Procedure from the Developer s Perspective The developer must provide 1. A means of initiating an inbound registration message from the device to the network coordinator. While in registration mode, the application controller should indicate when it is ready for the user to trigger a registration message from the device. A registration message is simply a reset message sent from the device. A reset message will be sent when the Reset button is pressed on the device to be registered. 2. A means of processing the message as it is passed from the RF gateway to the application controller. The registration message transmitted in the previous step will be received by the RF gateway and delivered serially to the application controller. The application controller must validate this message, extract the device s UID, and store it in the application database. Thereafter, the UID will be used to associate the wireless point with program functionality. 3. A means of letting the user know the registration message has been received by the application controller. At a minimum, the application controller should provide some indication that the registration was successful. Preferably, the UID of the registered device should be displayed. At this time the application controller may begin the setup process for the next point or may begin normal operation. This action is application specific. 2.4 Device Reset, Application Controller Not in Registration Mode There are cases where the device will send a reset message when the application controller is not in registration mode. When the battery is changed on an EchoStream device, for instance, it must be reactivated by the user pressing the reset button. A device may also transmit a reset message upon Revision E 8

9 Registration recovery from an electrostatic discharge event. The identical type of reset message transmitted during the registration process is transmitted by the device during these instances, however the application controller must process these messages differently. If the application controller is not in registration mode and a reset message from a previously registered device is received, the application controller should record this message in its event log as a device reset. Other status bits that may be active in the message from the device should be processed in an identical manner as when processed when the reset bit is not active. 2.5 Removing a Registered Device from the System To remove a registered wireless device from the system, the application controller is placed in registration mode. The user then selects the point to be deleted. When the user selects delete for that point, the application controller will adjust the database to remove all information, or replace the unique ID associated with that point with a unique ID of zero and set a flag to indicate that the point no longer has a device assigned to it. If a particular device has been registered to more than one point and the user wants to completely remove that device from the system, then the user must delete that device from each point to which it is registered. Revision E 9

10 Chapter 3 Message Information 3.1 Analog Data Message Each analog measurement is sent as an IEEE-754 single-precision, floating point number stored in four bytes, with the most significant byte first. The dual analog sensor transmitter will send two four-byte packets. The product type identifier (PTI) byte and the data format (DFM) byte define the meaning of each of the data bytes Measurement Value Valid Range If the measurement value is below the low valid limit then the negative infinity value, 0xFF800000, is returned. If the measurement value is above the high valid limit then the positive infinity value, 0x7F800000, is returned Valid Ranges Table 3-1 Sensor Output Setting High Valid Limit Low Valid Limit 0-10V 10.1V 0.03V 0-5V 5.1V 0.03V 4-20mA 20.1mA 0.1mA Message Formats Messages from the end device to the application controller adhere to the formats defined following. Revision E 10

11 Message Information Note: The format of EchoStream messages will vary depending on the message type. Always check the message class byte before attempting to determine the contents of a message Two Analog Measurements without Options [0x72] Header for Inbound Complete message. [LEN] Message length, excluding checksum. [Unique ID (4) originator] Unique ID of device originating message. [Unique ID (4) first hop] Unique ID of the device which received original message, as well as the signal level and margin. If the UID begins with 00, then the RF gateway is the first hop; if the UID begins with 01, then the repeater is the first hop. [Trace count] - Number of trace unique IDs that follow. The default is zero, indicating no trace data. FUTURE: [Trace Unique ID1 (4)]...[Trace Unique IDn (4)] - Unique ID of each device that repeats this message. [Hop count (1)] The number of times this message was relayed by a device. [0x37] - Message class byte for payload with data format byte. [0x20] - Product type identifier for dual analog transmitter. Note: See Product Type Identifiers for EchoStream Devices on page 14 for product type identifier information. [DFM] - Data format byte. [0x00] mA data [0x02] - 0-5V data [0x04] V data [Measurement1 (4)] - Analog measurement data for sensor 1. [Measurement2 (4)] - Analog measurement data for sensor 2. Note: If no sensor is attached, the negative infinity value, 0xFF800000, is returned. [STAT1] - Application flags. Bit 7 - Delta A. Bit Reserved. [STAT0] - Primary status flags. Revision E 11

12 Message Information Bit 7 - Reserved. Bit 6 - Low battery. Bit 5 - Reserved. Bit 4 - Set when there has been no change in status since the last transmission. Bit 3 - Reset. Bit 2 - Reserved. Bit 1 - Reserved. Bit 0 - Reserved. [Level] - Signal level of message as measured by the first hop device. [Margin] - Signal margin of message as measured by the first hop device. [CKSUM] - Checksum Two Analog Measurements with Options Note: This message is transmitted only when the end device Reset button is pushed. [0x72] Header for Inbound Complete message. [LEN] Message length, excluding checksum. [Unique ID (4) originator] Unique ID of device originating message. [Unique ID (4) first hop] Unique ID of the device which received original message, as well as the signal level and margin. If the UID begins with 00, then the RF gateway is the first hop; if the UID begins with 01, then the repeater is the first hop. [Trace count] - Number of trace unique IDs that follow. The default is zero, indicating no trace data. FUTURE: [Trace Unique ID1 (4)]...[Trace Unique IDn (4)] - Unique ID of each device that repeats this message. [Hop count (1)] The number of times this message was relayed by a device. [0x37] - Message class byte for payload with data format byte. [0x20] - Product type identifier for dual analog transmitter. Note: See Product Type Identifiers for EchoStream Devices on page 14 for product type identifier information. [DFM] - Data format byte. Revision E 12

13 Message Information [0x01] mA data with options bytes [0x03] - 0-5V data with options bytes [0x05] V data with options bytes [Measurement1 (4)] - Analog measurement data for sensor 1. [Measurement2 (4)] - Analog measure data for sensor 2. [OPT1] Bits Transmission interval, in seconds; 0: 10 seconds, 1: 30 seconds, 2: 1 minute, 3: 2 minutes, 4: 5 minutes, 5: 10 minutes, 6:15 minutes, 7: 30 minutes, 8-15: unused. (Default = 5 minutes) Bits Measurement interval, in seconds; 0: only on transmission, 1: 0.5 seconds, 2: 1 second, 3: 5 seconds, 4: 30 seconds, 5: 1 minute, 6: 5 minutes, 7: 15 minutes, 8-15: unused. (Default = 30 seconds) [OPT0] Bit Reserved. Bit Delta A value in selected measurement units (Volts or mamps); 0: feature disabled, 1: 0.05, 2: 0.1, 3: 0.5, 4: 1.0, 5: 5.0, 6-7: reserved. (Default = 0.5) [STAT1] - Application flags. Bit 7 - Delta A. Bit Reserved. [STAT0] - Primary status flags. Bit 7 - Reserved. Bit 6 - Low battery. Bit 5 - Reserved. Bit 4 - Set when there has been no change in status since the last transmission. Bit 3 - Reset. This bit is set on this message. Bit 2 - Reserved. Bit 1 - Reserved. Bit 0 - Reserved. [Level] - Signal level of message as measured by the first hop device. [Margin] - Signal margin of message as measured by the first hop device. [CKSUM] - Checksum. Revision E 13

14 Message Information 3.2 Product Type Identifiers for EchoStream Devices Product Naming Conventions ES indicates EchoStream products with selectable 868 or 900 MHz operation. EN indicates EchoStream products that operate at 900 MHz only. EE indicates EchoStream products that operate at 868 MHz only. E* represents products available in both EE and EN versions EchoStream Device Identifiers Table Product Description Market ID Product Type End Device Type E*1702 Analog End Device 0xC0 0x20 One-Way Revision E 14

15 Chapter 4 Programming 4.1 Program the Dual Analog End Device The analog end device is programmed at the factory with a unique identification number and the following default settings: Transmission interval 5 minutes Measurement interval 30 seconds Delta value (volts or milliamps).05 If you would like to change these default settings the E*1702 dual analog end device can be programmed using the programming header and a developersupplied interface board and application. The programming header uses a serial data communication interface. Note: Press Reset after programming the end device to enable changes. Changes will not take effect until the end device is reset Create a Programming Device To program the E*1702 you will need to build a programming device and cable. You will need the following materials: Programming Cable Use the following materials to create a programming cable. Six Molex C-Grid box crimp terminals. Molex PN: , Digi-Key PN: WM2554-ND. Revision E 15

16 Programming Two Molex C-Grid connector housings. Molex PN: , Digi-Key PN: WM2520-ND. Two Tyco Electronics AMP keying plugs. Tyco Electronics PN: , Digi-Key PN: A19310-ND. One three-conductor, 22 or 24 gauge stranded wire (ribbon cable or equivalent) Programming Device Use the following materials to create a programming device according to the schematic in Figure 4-1. U1: Torex Semiconductor Ltd. XC6202 3V low dropout regulator, or equivalent U3: Intersil ICL3221E 3V RS-232 transceiver, or equivalent D1: Central Semiconductor CMPSH-3C dual Schottky common cathode diode, or equivalent Revision E 16

17 Programming Figure 4-1 E*1702 Programming Device Schematic Timing Requirements All data is set at a default rate of 9600 baud, no parity, eight data bits and one stop bit. The data is transmitted least significant bit first. Revision E 17

18 Programming Dual Analog End Device Programming Commands These commands allow for field programming of certain operational characteristics of the dual analog end devices. All commands are prefixed with a 0x60 header byte. Header Command Description Page 0x60 0x01 Write options 18 0x08 Read options 19 0x0E Read 1st sensor 19 0x0F Read 2nd sensor x01 Write Options [0x60] - Environmental programming header byte. [0x05] - Message length, excluding checksum. [0x01] - Write options command [OPT0] - Options byte 0 [OPT1] - Options byte 1 [CKSUM] - Checksum Options byte descriptions: [OPT0] Bit Reserved Bits Delta value; in volts or milliamps; 1: 0.05, 2: 0.1: 3: 0.5, 4: 1.0, 5: 5.0, 6-7 reserved. Default: 3. [OPT1] Bits Tranmission interval; 0: 10 seconds, 1: 30 seconds, 2: 1 minute, 3: 2 minutes, 4: 5 minutes, 5: 10 minutes, 6: 15 minutes, 7: 30 minutes, 8-15 reserved. Default: 4. Caution:If using the end device in Europe, the transmission interval must be no more frequent than one minute. Setting the transmission interval to less than one minute is in violation of European Telecommunications Standards Institute (ETSI) regulations. Bits Measurement interval, in seconds; 0: only on transmission, 1: 0.5 seconds, 2: 1 second, 3: 5 seconds, 4: 30 seconds, 5: 1 minute, 6: 5 minutes, 7: 15 minutes, 8-15 reserved. Default: 4. Returned message: Revision E 18

19 Programming Data Acknowledgement Or [0x06] - Header for data acknowledgement from transmitter [0x02] - Message length, excluding checksum. [0x08] - Checksum. Data Non-Acknowledgement (NAK) [0x15] - Header for non-acknowledgement from transmitter [0x03] - Message length, excluding checksum. [EE] - One byte error code [0x01]: checksum incorrect [0x02]: unrecognized header [0x03]: serial buffer full [0x04]: timeout; incomplete message [0x05]: EEPROM write error [0x06]: EEPROM read error [0x07]: invalid data [0x08]: unrecognized command [CKSUM] - Checksum x08 Read Options [0x60] - Environmental programming header byte. [0x03] - Message length, excluding checksum. [0x08] - Read options command [0x6B] - Checksum Returned message: NAK or data: [0x60] - Environmental header byte. [0x05] - Message length, excluding checksum. [0x08] - Read options command [OPT0] - Options 0 byte [OPT1] - Options 1 byte [CKSUM] - Checksum See Write Options command for option byte bit definitions x0E Read First External Sensor [0x60] - Environmental programming header byte. [0x03] - Message length, excluding checksum. [0x0E] - Read read first external sensor command [0x71] - Checksum Revision E 19

20 Programming Returned message: NAK, (0x15), or data: [0x60] - Environmental programming header byte. [0x07] - Message length, excluding checksum. [0x0E] - Read internal thermistor command [Measurement (4)] - Analog measurement [CKSUM] - Checksum x0F Read Second External Sensor [0x60] - Environmental programming header byte. [0x03] - Message length, excluding checksum. [0x0F] - Read second external sensor command [CKSUM] - Checksum Returned message: NAK, (0x15), or data: [0x60] - Environmental programming header byte. [0x07] - Message length, excluding checksum. [0x0F] - Read second external sensor command [Measurement (4)] - Analog measurement [CKSUM] - Checksum Revision E 20