Linx Technologies 900MCA Hummingbird MCA User Manual User Guide PRO
Linx Technologies Hummingbird MCA User Guide PRO
UserManual.wiki
>
Linx Technologies
>
900MCA User Manual
>
User Guide - PRO
Contents
1.
User Guide - PRO
2.
User Guide - RC
3.
User Manual - PRC
4.
User Manual - Pro
5.
User Manual - RC
User Guide - PRO
Navigation menu
Upload a User Manual
Namespaces
Wiki Guide
HTML
PDF
Info
Views
User Manual
Discussion / Help
Navigation
![– – – –18 19Addressing ModesThe module has very flexible addressing methods selected with the ADDMODE register. It can be changed during operation. The transmitting module addresses packets according to the addressing mode configuration. The receiving module processes all addressing types regardless of the ADDMODE configuration. If the received message matches the addressing criteria, it is output on the UART. Otherwise it is discarded. The ADDMODE configuration also enables assured delivery.There are three addressing modes: DSN, User and Extended User. Each mode offers different communications methods, but all use source and destination addressing. The source address is for the transmitting unit, the destination address is the intended receiver. Each mode uses different registers for the source and destination addresses.All three addressing modes can be configured to be compatible with the older 250 Series modules. The default operation has an additional level of masking on the receiving module that helps prevent interference from adjacent networks.The following sections give brief descriptions of the three modes, but a detailed explanation and examples are given in RG-00105, the HumPROTM Addressing Mode Reference Guide.DSN Addressing ModeDevice Serial Number Addressing mode is the simplest mode and supports point-to-point communications. Each module is programmed at the factory with a unique 4-byte serial number that cannot be changed. These bytes are found in the non-volatile read-only MYDSN registers (MYDSN[3-0]). DSN Addressing mode uses this serial number as an address. The transmitting unit’s DSN is used as the source address and the intended receiver’s DSN is written into the destination address registers (DESTDSN[3-0]). All modules within range hear the transmission, but only the module with the serial number that matches the destination address outputs the data on its UART. All others ignore the transmission. User Addressing ModeUser Addressing Mode is a more flexible method than DSN Addressing Mode. It uses the customer ID bytes (CUSTID[1-0]) for unencrypted messages and two of the user destination bytes (UDESTID[1-0]) as a destination address. The customer ID bytes are programmed at the factory and cannot be changed. These are determined by the factory for specific customers to prevent their systems from operating with any other systems. Contact Linx for more details.The module’s local address is contained in two of the user source ID registers (USRCID[1-0]). In this mode, USRCID [1-0] contain the node address and USRCID [3-2] must be 0 in the receiver.In normal operation each module has a user ID mask (UMASK[3-0]) that splits the 32 address bits into up to three fields to provide a network address and address fields for sub-networks, supporting both individual addressing and broadcast addressing within the user’s network. A detailed explanation and examples are given in Reference Guide RG-00105. The 16 bits in the UDESTID[1-0] registers are transmitted. The upper 16 bits of USRCID[3-2] in the receiver must be 0.If acknowledgements are enabled, only the module with a user source ID that exactly matches the transmitted user destination ID responds. The mask is not used for this determination.Extended User Addressing ModeExtended User Addressing mode is the same as User Addressing mode but uses 32-bit addresses. The two customer ID bytes are still used (CUSTID[1-0]) but four bytes are used for the user destination address (UDESTID[3-0]), user source ID (USRCID[3-0]) and user ID mask (UMASK[3-0]). This provides more addressing capabilities at the expense of more overhead in the packet.](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-12.png)
![– – – –20 21Acknowledgements and Assured DeliveryWhen a module transmits with assured delivery enabled, the receiving module returns an acknowledgement packet. The transmitting module waits for this acknowledgement for a preset amount of time based on the data rate. If an acknowledgement is not received, it retransmits the packet. If the receiver receives more than one of the same packet, it discards the duplicate packet contents but sends an acknowledgment. This way, duplicate data is not output by the module. If the received destination address matches the local address, the receiving module immediately sends an acknowledgement. This packet lets the sending module know that the message has been received. An acknowledgement packet is sent immediately following reception; CSMA delay is not applied to these packets since permission belongs to the interacting modules. When the sending module receives the acknowledgement packet, it marks the current block of data as completed. If this is the last message in the queue, the sending module takes the BE line high to indicate that all outgoing data has been sent.Assured delivery should only be used when addressing a specific module in a point-to-point link. It should not be used when multiple receivers are enabled. When address masking is used, only the receiver with an exact match to the address in the transmitted packet responds. If none of the enabled receivers has an exact match, then there is no response and the transmitting module continues to re-transmit the data until the max number of retries is attempted. This causes the transmitting module to appear slow or unresponsive. It also impedes valid communications.Automatic AddressingThe module supports an automatic addressing mode that reads the Source Address from a valid received packet and uses it to fill the Destination Address register. This makes sure that a response is sent to the device that transmitted the original message. This also allows the host microcontroller to read out the address of the sending unit. The automatic addressing is enabled for the different addressing modes with register AUTOADDR. Address Register UseFigure 20 shows the address registers that are used with each addressing mode.Figure 20: HumPROTM Series Transceiver Address Register UseHumPROTM Series Transceiver Address RegistersCOMPAT 0x00 (Relaxed Addressing) 0x02 (Normal Addressing)ADDMODE0x04 (DSN)0x06 (User)0x07 (Ex User)0x04 (DSN)0x06 (User)0x07 (Ex User)0x14 (DSN+ACK)0x16 (User+ACK)0x17 (ExUser+ACK)0x14 (DSN+ACK)0x16 (User+ACK)0x17 (ExUser+ACK)UDESTID[3-0] X XUDESTID[1-0] X XUSRC[3-0] X X XUSRC[1-0] XUMASK[3-0] X X XUMASK[1-0] XDESTDSN[3-0] X X](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-13.png)
![– – – –38 39Figure 33 shows the MODE_IND displays in a graphical format.Using the PB LineThe PB Line is used to trigger functions associated with the JOIN process. This line should be connected to a momentary pushbutton that pulls the line to VCC when it is pressed and opens the circuit when it is released. There is no internal pull-down, so a resistor to ground should be used to pull the line down when the button is not pressed. A value of 10kΩ to 100kΩ works well.The sequence of presses determines which function is triggered. Figure 32 shows the sequences.Figure 31: HumPROTM Series MODE_IND Line TimingUsing the MODE_IND LineThe MODE_IND line is designed to be connected to an LED to provide visual indication of the module’s status and current actions. The pattern of blinks indicates the particular feedback from the module. Figure 31 shows the different blink patterns and their meanings.MODE_IND Line TimingDisplay [on/off time in seconds] Module StatusJoin OperationTwo quick blinks Master Join. The master unit is looking for a slave unit to join with.One quick blink Slave Join. The slave unit is looking for a master unit to join with.Quick blink Key Transfer Active. Key transfer is taking place (master and slave).Slow Blink Key Transfer Complete. The module has completed a key transfer (master and slave).Temporary On On when the PB line is highTwo quick blinks, one time Join Canceled.Slow blink, repeat 3 times Failure. For Share Key or Get Key, there are multiple units attempting to pair, protocol error, or timeout without responseSlow blink and two quick blinksLong Hold Acknowledgement. The long hold period for Generate Key or Reset Sequence was recognized (PB is asserted)Key Test ResultsOne quick blink Three times No Key. There is no network key or network address.Two quick blinks Three timesKey Set, slave. The network key and network address are set on a slave unit.Three quick blinks Three timesKey Set, master. The network key and network address are set on a master unit.Normal operationOff No activity Temporarily on Transmitting or receiving packetMaster JoinSlave JoinKey Transfer ActiveRepeats for 30 seconds or until JOIN is completeRepeats for 30 seconds or until JOIN is completeRepeats for the duration of the transferKey Transfer CompleteJOIN CancelledLong HoldRepeats for as long as the PB line is assertedafter the long hold period has been recognized FailureNo Key SetRepeats, three times totalKey Set, SlaveRepeats, three times totalKey Set, MasterRepeats, three times totalOperationMODE_IND Display CommentsSix blinks total0 0.5 121.5 2.5Time (seconds)Figure 33: HumPROTM Series MODE_IND DisplaysPB Line OperationFunction SequenceJoin a network 1 short pulseCancel a Join Process that is in progress 1 short pulseGenerate a network key and address Hold PB high for 30 secondsReset to factory defaults 4 short pulses and hold high for 3 secondsTest key and address 3 short pulsesA short pulse is a logic high that is between 100 and 2,000ms in duration.Figure 32: HumPROTM Series PB Line Operation](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-22.png)
![– – – –42 43The Command Data InterfaceThe HumPROTM Series transceiver has a serial Command Data Interface (CDI) that is used to configure and control the transceiver through software commands. This interface consists of a standard UART with a serial command set. The CMD_DATA_IN and CMD_DATA_OUT lines are the interface to the module’s UART. The UART is configured for 1 start bit, 1 stop bit, 8 data bits, no parity and a serial data rate set by register UARTBAUD (default 9,600bps). The CMD line tells the module if the data on the UART is for configuration commands (low) or data transmission (high). The module has a 256 byte buffer for incoming data. The module starts transmitting when the buffer reaches a specified limit or when the time since the last received byte on the UART reaches a specified value. This allows the designer to optimize the module for fixed length and variable length data.If the buffer gets nearly full (about 224 bytes), the module pulls the CTS line high, indicating that the host should not send any more data. Data sent by the host while the buffer is full is lost, so the CTS line provides a warning and should be monitored. When there is outgoing data waiting to be transmitted or acknowledged the BE line is low, otherwise BE is high.Configuration settings are stored in two types of memory inside the module. Volatile memory is quick to access, but it is lost when power is removed from the module. Non-volatile memory takes longer to access, but is retained when power is removed. When a configuration parameter has both a non-volatile and volatile register, the volatile register controls the operation. The non-volatile register is the default value that is loaded into the volatile register on power-up.Configuration settings are read from non-volatile memory on power up and saved in volatile memory since it is faster to read and write the volatile memory locations. The volatile and non-volatile registers have different address locations, but the same read and write commands. The two locations can be changed independently.The general serial command format for the module is:[FF] [Length] [Command]The Length byte is the number of bytes in the Command field. The Command field contains the register address that is to be accessed and, in the case of a write command, the value to be written. Neither Length nor Command can contain a 0xFF byte. Byte values of 128 (0x80) or greater can be sent as a two-byte escape sequence of the format: 0xFE, [value - 0x80]For example, the value 0x83 becomes 0xFE, 0x03. The Length count includes the added escape bytes. A response is returned for all valid commands. The first response byte is CMD_ACK (0x06) or CMD_NACK (0x15). Additional bytes may follow, as determined by the specific command.Reading from RegistersA register read command is constructed by placing an escape character (0xFE) before the register number. The module responds by sending an ACK (0x06) followed by the register number and register value. The register value is sent unmodified, so if the register value is 0x83, 0x83 is returned. If the register number is invalid, the module responds with a NACK (0x15). The command and response are shown in Figure 35.Figure 35: HumPROTM Series Read from Configuration Register Command and ResponseHumPROTM Series Read From Configuration RegisterCommandHeader Size Escape Address0xFF 0x02 0xFE REGResponseACK Address Value0x06 REG VCommand for an Address greater than 128 (0x80)Header Size Escape Addr1 Addr20xFF 0x03 0xFE 0xFE REG-80ResponseACK Address Value0x06 REG V](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-24.png)
![– – – –44 45Writing to RegistersTo allow any byte value to be written, values of 128 (0x80) or greater can be encoded into a two-byte escape sequence of the format 0xFE, [value - 0x80]. This includes register addresses as well as values to be written to the registers. The result is that there are four possible packet structures because of the possible escape sequences. These are shown in Figure 36. Generally, there are three steps to creating the command.1. Determine the register address and the value to be written.2. Encode the address and value as either the number (N) or the encoded number (0xFE, N-0x80) as appropriate.3. Add the header (0xFF) and the size.The module responds with an ACK (0x06). If the ACK is not received, the command should be resent. The module responds with a NACK (0x15) if a write is attempted to a read-only or invalid register.As an example, to write 01 to register 0x83, sendFF 03 FE 03 01Figure 36: HumPROTM Series Write to Configuration Register CommandHumPROTM Series Write to Configuration Register CommandCommand for a Register and Value less than 128 (0x80)Header Size Address Value0xFF 0x02 REG VCommand for a Register less than 128 (0x80) and a Value greater than 128 (0x80)Header Size Address Escape Value0xFF 0x03 REG 0xFE V-0x80Command for a Register greater than 128 (0x80) and a Value less than 128 (0x80)Header Size Addr1 Addr2 Value0xFF 0x03 0xFE REG-0x80 VCommand for a Register and Value greater than 128 (0x80)Header Size Addr1 Addr2 Escape Value0xFF 0x04 0xFE REG-0x80 0xFE V-0x80Note: The non-volatile memory has a life expectancy of at least 26,000 write operations.Command Length OptimizationSome commands may be shortened by applying the following rules:1. Escape sequences are not required for byte values 0x00 to 0xEF (besides 0xFE and 0xFF, bytes 0xF0 – 0xFD are reserved for future use).2. An escape byte inverts bit 7 of the following data byte.3. The 0xFE as the first byte of the Read Register Command field is an escape byte.4. Two consecutive escape bytes cancel unless the following data byte is 0xf0-0xff.Examples:• FF 02 FE 02 (read nv:TXPWR) is equivalent to FF 01 82.• FF 03 FE FE 53 (read v:PKOPT) is equivalent to FF 01 53.• FF 03 1A FE 7F (write FF to nv:UMASK0) cannot be shortened.• FF 03 1A FE 40 (write C0 to nv:UMASK0) is equivalent to FF 02 1A C0.These rules are implemented in the sample code file EncodeProCmd.c, which can be downloaded from the Linx website.](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-25.png)
![– – – –46 47 return dx;}/* Function: HumProRead** Description: This function encodes a read command to the specified** register address.*/unsigned char /* number of encoded bytes, 3 to 4 */HumProRead( unsigned char *cmd, /* out: encoded read command, length >= 4 */ unsigned char reg /* register number to read, 0..0xff */) { unsigned char ra; /* read register byte */ ra = reg ^ 0x80; return HumProCommand(cmd, &ra, 1);}/* Function: HumProWrite** Description: This function encodes a command to write a single byte to** a specified register address.*/unsigned char /* number of encoded bytes, 4 to 6 */HumProWrite( unsigned char *cmd, /* out: encoded read command, length >= 6 */ unsigned char reg, /* register number to write, 0..0xff */ unsigned char val /* value byte, 0..0xff */) { unsigned char cs[2]; cs[0] = reg; cs[1] = val; return HumProCommand(cmd, &cs, 2);}Example Code for Encoding Read/Write CommandsThis software example is provided as a courtesy in “as is” condition. Linx Technologies makes no guarantee, representation, or warranty, whether express, implied, or statutory, regarding the suitability of the software for use in a specific application. The company shall not, in any circumstances, be liable for special, incidental, or consequential damages, for any reason whatsoever.File EncodeProCmd.c/* Sample C code for encoding Hum-xxx-PRO commands**** Copyright 2015 Linx Technologies** 155 Ort Lane** Merlin, OR, US 97532** www.linxtechnologies.com**** License:** Permission is granted to use and modify this code, without royalty, for** any purpose, provided the copyright statement and license are included.*/#include “EncodeProCmd.h”/* Function: HumProCommand** Description: This function encodes a command byte sequence.** If len = 1, a read command is generated.** If len > 1, a write command is generated.** rcmd[0] = register number** rcmd[1..(n-1)] = bytes to write*/unsigned char /* number of encoded bytes, n+2 to 2*n+2 */HumProCommand( unsigned char *ecmd, /* out: encoded command, length >= 2*n + 2 */ const unsigned char *rcmd, /* in: sequence of bytes to encode */ unsigned char n /* number of bytes in rcmd, 1..32 */) { unsigned char dx; /* destination index */ unsigned char sx; /* source index */ unsigned char v; /* value to be encoded */ dx = 2; sx = 0; while (n--) { v = rcmd[sx++]; if (v >= 0xf0) { ecmd[dx++] = 0xfe; v &= 0x7f; } ecmd[dx++] = v; } ecmd[0] = 0xff; ecmd[1] = dx - 2;](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-26.png)
![– – – –48 49DESTDSN0 0x20 0x6B R/W 0xFF Destination Device Serial NumberEXMASK 0x21 0x6C R/W 0x00 Exception Mask to activate EXCMDHOLD 0x23 0x6E R/W 0x00 Hold RF data when nCMD pin is lowCOMPAT 0x25 0x70 R/W 0x02 CompatibilityAUTOADDR 0x26 0x71 R/W 0x00 Automatic Reply AddressMYDSN3 0x34 R Factory programmed Serial NumberMYDSN2 0x35 R Factory programmed Serial NumberMYDSN1 0x36 R Factory programmed Serial NumberMYDSN0 0x37 R Factory programmed Serial NumberCUSTID1 0x39 R 0xFF Factory programmed customer IDCUSTID0 0x3A R 0xFF Factory programmed customer IDCRSSI 0x3F R/W 0xBA Carrier Sense minimum RSSIRELEASE 0x78 R Release numberEXCEPT 0x79 R 0x00 Exception codePRSSI 0x7B R 0x00 Packet RSSI ARSSI 0x7C R 0x00 Ambient RSSI FWVER3 0xC0 R Firmware version, majorFWVER2 0xC1 R Firmware version, minorFWVER1 0xC2 R Firmware version, incrementFWVER0 0xC3 R Firmware version, suffix NVCYCLE1 0xC4 R NV Erase Cycles, MSNVCYCLE0 0xC5 R NV Erase Cycles, LSLSTATUS 0xC6 R Output line statusCMD 0xC7 W Command registerSECSTAT 0xC9 R Security StatusJOINST 0xCA R 0x00 Join StatusEEXFLAG2 0xCD R/W 0x00 Extended exception flagsEEXFLAG1 0xCE R/W 0x00 Extended exception flagsEEXFLAG0 0xCF R/W 0x00 Extended exception flagsEEXMASK2 0x80 0xD0 R/W 0x00 Extended exception maskEEXMASK1 0x81 0xD1 R/W 0x00 Extended exception maskEEXMASK0 0x82 0xD2 R/W 0x00 Extended exception maskPKTOPT 0x83 0xD3 R/W 0x00 Packet optionsSECOPT 0x84 0xD4 R/W 0xFF Security OptionsLASTNETAD[3] 0x8C R/W 0x00 Last Network Address AssignedLASTNETAD[2] 0x8D R/W 0x00 Last Network Address AssignedLASTNETAD[1] 0x8E R/W 0x00 Last Network Address AssignedLASTNETAD[0] 0x8F R/W 0x00 Last Network Address AssignedThe Command Data Interface Command SetThe following sections describe the registers. HumPROTM Series Configuration RegistersName NV AddrVol Addr R/W Default Value DescriptionCRCERRS 0x40 R/W 0x00 CRC Error CountHOPTABLE 0x00 0x4B R/W 0x00 Channel Hop TableTXPWR 0x02 0x4D R/W 0x03 Transmit Power UARTBAUD 0x03 0x4E R/W 0x01 UART data rateADDMODE 0x04 0x4F R/W 0x04 Addressing modeDATATO 0x05 0x50 R/W 0x10 Data timeoutMAXTXRETRY 0x07 0x52 R/W 0x1A Maximum Transmit RetriesENCRC 0x08 0x53 R/W 0x01 Enable CRC checkingBCTRIG 0x09 0x54 R/W 0x40 Byte Count triggerSHOWVER 0x0A R/W 0x01 Show version on startupENCSMA 0x0B 0x56 R/W 0x01 Enable CSMAIDLE 0x0D 0x58 R/W 0x00 Idle ModeWAKEACK 0x0E 0x59 R/W 0x01 UART Acknowledge on Wake UDESTID3 0x0F 0x5A R/W 0xFF Destination Address for User Packet Type, extendedUDESTID2 0x10 0x5B R/W 0xFF Destination Address for User Packet Type, extendedUDESTID1 0x11 0x5C R/W 0xFF Destination Address for User Packet TypeUDESTID0 0x12 0x5D R/W 0xFF Destination Address for User Packet TypeUSRCID3 0x13 0x5E R/W 0xFF Source Address for User Packet Type, extendedUSRCID2 0x14 0x5F R/W 0xFF Source Address for User Packet Type, extendedUSRCID1 0x15 0x60 R/W 0xFF Source Address for User Packet TypeUSRCID0 0x16 0x61 R/W 0xFF Source Address for User Packet TypeUMASK3 0x17 0x62 R/W 0xFF Address Mask for User Packet Type, extendedUMASK2 0x18 0x63 R/W 0xFF Address Mask for User Packet Type, extendedUMASK1 0x19 0x64 R/W 0xFF Address Mask for User Packet TypeUMASK0 0x1A 0x65 R/W 0xFF Address Mask for User Packet TypeDESTDSN3 0x1D 0x68 R/W 0xFF Destination Device Serial NumberDESTDSN2 0x1E 0x69 R/W 0xFF Destination Device Serial NumberDESTDSN1 0x1F 0x6A R/W 0xFF Destination Device Serial NumberFigure 37: HumPROTM Series Configuration Registers](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-27.png)
![– – – –84 85The Join Process Control command allows the software to initiate or stop the secure JOIN process. It has the following subcommands.These operations are equivalent to the push-button initiated operation. If a JOIN operation is started by the serial command (CMD:JOINCTL[2]), push-button operation is ignored until the JOIN operation finishes.Register write operations are inhibited when a JOIN process is active except that a Halt JOIN command is never inhibited. A Halt JOIN operation completes before the ACK is sent.When the JOIN operation is started the KEYRCV flag in the SECOPT register determines whether the module is a master or slave and whether a key can be sent or changed. The JOIN process uses and modifies the non-volatile address registers.The Write Key command writes a 16-byte AES key to the selected key register. As with most of the registers, the encryption key has both volatile and non-volatile registers. The volatile register is used during run time, but is lost on a power cycle or reset. When the module powers up, the volatile register is loaded from the non-volatile register. This makes the non-volatile register value the default on power-up.The key value of all zero bytes is reserved as a “no key” indication.Figure 92 shows the command for writing the AES key to the module.If KeyN is 0x01, the command writes to the volatile key register. If it is 0x02, it writes to the non-volatile key register. HumPROTM Series JOINCTL Subcommand ValuesSubcommand Value Operation0 Halt JOIN operation1Generate a random network key and address. This sets the module as the network master (SECOPT:KEYRCV=0)2 Perform the JOIN operation with another moduleFigure 91: HumPROTM Series JOINCTL Subcommand ValuesFigure 92: HumPROTM Series Transceiver Write Key CommandHumPROTM Series Write Key CommandWrite CommandHeader Size Escape Address Value KeyN Key0 ... Key150xFF Size 0xFE 0x47 0x11 KeyN Key0 ... Key15The Clear Key command sets the selected key to all zeros. Figure 93 shows the structure of this command.If KeyN is 0x01, the command writes to the volatile key registers. If it is 0x02, it writes to the non-volatile key registers.The Reload Key command copies the key in non-volatile memory (NKN) to the volatile location (NKV). This allows a sophisticated system to change the keys during operation and quickly revert back to the default key.The Non-volatile Reset command (FF 07 FE 47 20 FE 2A FE 3B) sets all non-volatile registers to their default values. When the configuration is reset, the following message, shown in quotes, is sent out the UART at the current baud rate, then the module is reset, similar to a power cycle:“\r\nConfiguration Reset\r\n”.This reset can also be done by toggling the PB line as described in the Restore Factory Defaults section.Figure 93: HumPROTM Series Transceiver Clear Key CommandHumPROTM Series Clear Key CommandWrite CommandHeader Size Escape Address Value KeyN0xFF 0x04 0xFE 0x47 0x12 KeyN](https://usermanual.wiki/Linx-Technologies/900MCA.User-Guide-PRO/User-Guide-2637858-Page-45.png)
