ZigBee® 802.15.4 network processor Integrated 2.4GHz, IEEE 802.15
|
|
|
Top Searches for this datasheet
SN260
ZigBee® 802.15.4 network processor
Integrated 2.4GHz, IEEE 802.15.4-compliant transceiver: Robust filtering allows co-existence with IEEE 802.11g Bluetooth devices 97.5dBm sensitivity PER, 20byte packet) 3dBm nominal output power Increased radio performance mode (boost mode) gives -98.5dBm sensitivity +5dBm transmit power Integrated loop filter Secondary TX-only port applications requiring external Integrated IEEE 802.15.4 Dedicated peripherals integrated memory EmberZNetZigBee®-compliant stack running dedicated network processor
Controlled Host using EmberZNetSerial Protocol (EZSP) Standard serial interface (allows connection variety Host micro controllers) Non-intrusive debug interface (SIF) Integrated hardware software support InSightDevelopment Environment Provides integrated oscillator power operation Three sleep modes: Processor idle (automatic) Deep sleep-1.0µA Power down-1.0µA Watchdog timer power-on-reset circuitry Integrated encryption accelerator Integrated 1.8V voltage regulator Compatible with Ember EM250
TX_ACTIVE
select
RF_TX_ALT_P,N
SYNTH Baseband
PacketTrace
RF_P,N BIAS_R OSCA
Bias
Network Processor (XAP2b)
Encryption acclerator
Network Processor Peripherals Integrated Flash
OSCB
Internal RC-OSC Serial Controller Interrupt Controller
Always powered Sleep timer Watchdog
nRESET SIF_CLK
VREG_OUT
Regulator Chip manager
SIF_MISO SIF_MOSI nSIF_LOAD
Controller
nSSEL_INT
nSSEL
SCLK
MISO
MOSI
nWAKE
nHOST_INT
LINK_ACTIVITY
PTI_DATA
April 2008
PTI_EN
SDBG
1/88
www.st.com
Contents
SN260
Contents
General description assignment Top-level functional description Electrical characteristics
Absolute maximum ratings Recommended operating conditions Environmental characteristics electrical characteristics Digital specifications electrical characteristics
4.6.1 4.6.2 4.6.3 Receive Transmit Synthesizer
Functional description
Receive (RX) path
5.1.1 5.1.2 baseband RSSI
Transmit (TX) path
5.2.1 5.2.2 baseband TX_ACTIVE signal
Integrated module Packet trace interface (PTI) 16-bit microprocessor Embedded memory
5.6.1 5.6.2 Simulated EEPROM Flash information area (FIA)
Encryption accelerator Reset detection Power-on-reset (POR)
2/88
SN260
Contents
5.10
Clock sources
5.10.1 5.10.2 High-frequency crystal oscillator Internal oscillator
5.11 5.12 5.13 5.14
Random number generator Watchdog timer Sleep timer Power management
protocol
Physical interface configuration transaction
6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.2.6 6.2.7 Command section Wait section Response section Asynchronous signaling Spacing Waking SN260 from sleep Error conditions
protocol timing Data format byte
6.5.1 6.5.2 Primary bytes Special response bytes
Powering power cycling, rebooting
6.6.1 Unexpected resets
Transaction examples
6.7.1 6.7.2 6.7.3 6.7.4 protocol version EmberZNet serial protocol frame command SN260 reset Three-part transaction: Wake, Version, Stack Status Callback
EmberZNet serial protocol
Byte order Conceptual overview
7.2.1 7.2.2 Stack configuration Policy settings
3/88
Contents 7.2.3 7.2.4 7.2.5 7.2.6 7.2.7 7.2.8 7.2.9
SN260 Datagram replies Callbacks Power management Tokens SN260 status Random number generator
Protocol format
7.3.1 7.3.2 7.3.3 7.3.4 7.3.5 7.3.6 7.3.7 7.3.8 7.3.9 Type definitions Structure definitions Named values Configuration frames Utilities frames Networking frames Binding frames Messaging frames Alphabetical list frames
Sample transactions
7.4.1 7.4.2 7.4.3 7.4.4 Joining Binding Sending Receiving
module programming debug interface Typical application Mechanical details Ordering information Abbreviations acronyms References Revision history
4/88
SN260
General description
General description
SN260 integrates 2.4GHz, IEEE 802.15.4-compliant transceiver with 16-bit network processor (XAP2b core) EmberZNetTM, ZigBee-compliant network stack. SN260 exposes access EmberZNet across standard module, allowing application development Host processor. This means that SN260 viewed ZigBee peripheral connected over SPI. XAP2b microprocessor power-optimized core integrated SN260. contains integrated Flash memory along with optimized peripheral enhance operation network stack. transceiver utilizes efficient architecture that exceeds dynamic range requirements imposed IEEE 802.15.4-2003 standard over 15dB. integrated receive channel filtering allows co-existence with other communication standards 2.4GHz spectrum such IEEE 802.11g Bluetooth. integrated regulator, VCO, loop filter, power amplifier keep external component count low. optional highperformance radio mode (boost mode) software selectable boost dynamic range further 3dB. SN260 contains embedded Flash integrated program data storage. employing effective wear-leveling algorithm, stack optimizes lifetime embedded Flash, affords application ability configure stack application tokens within SN260. maintain strict timing requirements imposed ZigBee IEEE 802.15.4-2003 standard, SN260 integrates number functions into hardware. hardware handles automatic transmission reception, automatic backoff delay, clear channel assessment transmission, well automatic filtering received packets. addition, SN260 allows true level debugging integrating Packet Trace Interface. integrated voltage regulator, power-on-reset circuitry, sleep timer, low-power sleep modes available. deep sleep power down modes draws less than allowing products achieve long battery life. Finally, SN260 utilizes non-intrusive module powerful software debugging programming network processor. Target applications SN260 include:
Building automation control Home automation control Home entertainment control Asset tracking
SN260 only purchased with EmberZNet stack. This technical datasheet details SN260 features available customers using with EmberZNet stack.
5/88
assignment
SN260
assignment
Figure SN260 assignment
VDD_SYNTH_PRE
LINK_ACTIVITY
VDD_24MHZ
VDD_FLASH
VDD_CORE
nWAKE
OSCA
OSCB
SDBG
VDD_VCO RF_P RF_N VDD_RF RF_TX_ALT_P RF_TX_ALT_N VDD_IF BIAS_R VDD_PADSA TX_ACTIVE
nSIF_LOAD SIF_MOSI SIF_MISO SIF_CLK nHOST_INT VDD_PADS PTI_DATA PTI_EN nSSEL
EM260
SN260
SCLK
VDD_CORE
VDD_PADS
VREG_OUT
Table
descriptions
Signal VDD_VCO RF_P RF_N VDD_RF RF_TX_ALT_P RF_TX_ALT_N VDD_IF BIAS_R VDD_PADSA TX_ACTIVE Direction Power Power Power Power 1.8V supply Differential (with RF_N) receiver input/transmitter output Differential (with RF_P) receiver input/transmitter output 1.8V supply (LNA Differential (with RF_TX_ALT_N) transmitter output (optional) Differential (with RF_TX_ALT_P) transmitter output (optional) 1.8V supply (mixers filters) Bias setting resistor Analog supply (1.8V) Logic-level control external RX/TX switch SN260 baseband controls TX_ACTIVE drives high (1.8V) when mode. (Refer Table section TX_ACTIVE signal.) Description
6/88
VDD_PADS
nRESET
nSSEL_INT
MISO
MOSI
SN260 Table
assignment descriptions (continued)
Signal nRESET VREG_OUT VDD_PADS VDD_CORE nSSEL_INT MOSI MISO VDD_PADS SCLK nSSEL PTI_EN PTI_DATA VDD_PADS nHOST_INT SIF_CLK SIF_MISO SIF_MOSI nSIF_LOAD VDD_FLASH SDBG LINK_ACTIVITY nWAKE VDD_CORE VDD_SYNTH_PRE OSCB OSCA VDD_24MHZ Power Power Power Power Power Ground Power Power Direction Power Power Power Description Active chip reset (internal pull-up) Regulator output (1.8V) Pads supply (2.1 3.6V) 1.8V digital core supply Slave Select Interrupt (from Host SN260) This signal must connected nSSEL (Pin Reserved future use, connect signal. Data, Master Slave (from Host SN260) Data, Master Slave (from SN260 Host) Pads supply (2.1 3.6V) Clock (from Host SN260) Slave Select (from Host SN260) Frame signal Packet Trace Interface (PTI) Data signal Packet Trace Interface (PTI) Pads supply (2.1 3.6V) Reserved future use, connect signal. Host Interrupt signal (from SN260 Host) Serial Interface, Clock (internal pull down) Serial Interface, Master Slave Serial Interface, Master Slave Serial Interface, load strobe (open collector with internal pull Ground Supply 1.8V Flash memory supply Spare Debug signal Link Activity signal Wake Interrupt signal (from Host SN260) 1.8V digital core supply 1.8V synthesizer pre-scalar supply 24MHz crystal oscillator left open when using external clock input OSCA 24MHz crystal oscillator external clock input 1.8V high-frequency oscillator supply Ground supply bottom center package forms (see EM260 Reference Design considerations)
7/88
Top-level functional description
SN260
Top-level functional description
Figure shows detailed block diagram SN260. Figure SN260 block diagram
TX_ACTIVE
select
RF_TX_ALT_P,N
SYNTH Baseband
PacketTrace
RF_P,N BIAS_R OSCA
Bias
Network Processor (XAP2b)
Encryption acclerator
Network Processor Peripherals Integrated Flash
OSCB
Internal RC-OSC Serial Controller Interrupt Controller
Always powered Sleep timer Watchdog
nRESET SIF_CLK
VREG_OUT
Regulator Chip manager
SIF_MISO SIF_MOSI nSIF_LOAD
Controller
nSSEL_INT
nSSEL
SCLK
MISO
MOSI
nHOST_INT
nWAKE
LINK_ACTIVITY
PTI_DATA
SDBG
radio receiver low-IF, super-heterodyne receiver. utilizes differential signal paths minimize noise interference, architecture been chosen optimize coexistence with other devices within 2.4GHz band (namely, IEEE 802.11g Bluetooth). After amplification mixing, signal filtered combined prior being sampled ADC. digital receiver implements coherent demodulator generate chip stream hardware-based MAC. addition, digital receiver contains analog radio calibration routines control gain within receiver path. radio transmitter utilizes efficient architecture which data stream directly modulates VCO. integrated boosts output power. calibration path well output power controlled digital logic. SN260 used with external TX_ACTIVE signal should used control timing external switching logic. integrated 4.8GHz loop filter minimize off-chip circuitry. Only 24MHz crystal with loading capacitors required properly establish reference signal. interfaces data memory baseband modules. provides hardware-based IEEE 802.15.4 packet-level filtering. supplies accurate symbol time base that minimizes synchronization effort software stack meets protocol timing requirements. addition, provides timer synchronization assistance IEEE 802.15.4 CSMA-CA algorithm.
8/88
PTI_EN
SN260
Top-level functional description SN260 integrates hardware support Packet Trace module, which allows robust packet-based debug. This element critical component InSightDesktop, Ember software IDE, providing advanced network debug capability when coupled with InSightAdapter. SN260 integrates 16-bit XAP2b microprocessor developed Cambridge Consultants Ltd. This power-efficient, industry-proven core provides appropriate level processing power meet needs ZigBee-compliant stack, EmberZNet. addition, module provides non-intrusive programming debug interface allowing realtime application debugging. SN260 exposes EmberZNet Serial over SPI, which allows application development occur Host micro controller choice. addition four signals, additional signals, nHOST_INT nWAKE, provide easy-to-use handshake mechanism between Host SN260. integrated voltage regulator generates regulated 1.8V reference voltage from unregulated supply voltage. This voltage decoupled routed externally supply 1.8V core logic. addition, integrated module allows proper cold start SN260. SN260 contains high-frequency (24MHz) crystal oscillator and, low-power operation, second low-frequency internal oscillator. SN260 contains power domains. always-powered high voltage supply used powering GPIO pads critical chip functions. rest chip powered regulated Voltage Supply which disabled during deep sleep reduce power consumption.
9/88
Electrical characteristics
SN260
Table
Electrical characteristics
Absolute maximum ratings
Table lists absolute maximum ratings SN260. Absolute maximum ratings
Parameter Test conditions Min. Max. Unit
Regulator voltage (VDD_PADS) Core voltage (VDD_24MHZ, VDD_VCO, VDD_RF, VDD_IF, VDD_PADSA, VDD_FLASH, VDD_SYNTH_PRE, VDD_CORE) Voltage RF_P,N; RF_TX_ALT_P,N Voltage nSSEL_INT, MOSI, MISO, SCLK, nSSEL, PTI_EN, PTI_DATA, nHOST_INT, SIF_CLK, SIF_MISO, SIF_MOSI, nSIF_LOAD, SDBG, LINK_ACTIVITY, nWAKE, nRESET, VREG_OUT Voltage TX_ACTIVE, BIAS_R, OSCA, OSCB Storage temperature
VDD_PADS+0.3
VDD_CORE+0.3
Table
Recommended operating conditions
Table lists rated operating conditions SN260. Operating conditions
Parameter Test conditions Min. Typ. Max. Unit
Regulator input voltage (VDD_PADS) Core input voltage (VDD_24MHZ, VDD_VCO, VDD_RF, VDD_IF, VDD_PADSA, VDD_FLASH, VDD_SYNTH_PRE, VDD_CORE) Temperature range
10/88
SN260
Electrical characteristics
Table
Environmental characteristics
Table lists environmental characteristics SN260. Environmental characteristics
Parameter Test Conditions Non-RF pins pins Min. Typ. Max. Unit
(human body model) (charged device model) (charged device model) (moisture sensitivity level)
Table
electrical characteristics
Table lists electrical characteristics SN260. characteristics
Parameter Test Conditions Min. Regulator output external input Typ. Max. Unit
Regulator input voltage (VDD_PADS) Power supply range (VDD_CORE) Deep sleep current Quiescent current, including internal oscillator current Radio receiver, MAC, baseband (boost mode) Radio receiver, MAC, baseband CPU, RAM, Flash memory Total current IRadio receiver, baseband, IRAM, Flash memory current Radio transmitter, MAC, baseband (boost mode) Radio transmitter, MAC, baseband max. power 5dBm typical) max. power 3dBm typical) 0dBm typical min. power 32dBm typical) CPU, RAM, Flash memory VDD_PADS 3.0V 1.8V core VDD_PADS 3.0V
29.0 27.0 35.5
33.0 27.0 24.3 19.5 35.5
Total current 1.8V core; max. IRadio transmitter, baseband, power IRAM, Flash memory
11/88
Electrical characteristics
SN260
Digital specifications
Table contains digital specifications SN260. digital power (named VDD_PADS) comes from three dedicated pins (pins 24). voltage applied these pins sets voltage.
Table
Digital specifications
Parameter Name VDD_PADS RIPU RIPD IOHS IOLS IOHH IOLH VDD_CORE 0.18 VDD_CORE 0.82 VDD_PADS 0.18 VDD_PADS VDD_PADS VDD_PADS 0.82 VDD_CORE Min. VDD_PADS Typ. Max. VDD_PADS VDD_PADS -0.5 Unit
Voltage supply Input voltage logic Input voltage logic Input current logic Input current logic Input pull-up resistor value Input pull-down resistor value Output voltage logic Output voltage logic Output source current (standard current pad) Output sink current (standard current pad) Output source current (high current pad: pins Output sink current (high current pad: pins Total output current (for pads) Input voltage threshold OSCA Output voltage level (TX_ACTIVE) Output source current (TX_ACTIVE)
12/88
SN260
Electrical characteristics
4.6.1
Note:
electrical characteristics
Receive
Table lists parameters integrated IEEE 802.15.4 receiver SN260. Receive measurements were collected with Ember's EM260 reference design 2440MHz. Typical number indicates standard deviation above mean. Receive characteristics
Parameter Test conditions Min. 2400 PER, 20byte packet defined IEEE 802.15.4 PER, 20byte packet defined IEEE 802.15.4 IEEE 802.15.4 signal -82dBm IEEE 802.15.4 signal 82dBm IEEE 802.15.4 signal 82dBm IEEE 802.15.4 signal 82dBm IEEE 802.15.4 signal 82dBm 98.5 97.5 IEEE 802.15.4 signal 82dBm Typ. Max. 2500 Unit
Table
Frequency range Sensitivity (boost mode) Sensitivity High-side adjacent channel rejection Low-side adjacent channel rejection
high-side adjacent channel rejection
low-side adjacent channel rejection Channel rejection other channels
802.11g rejection centered 12MHz IEEE 802.15.4 signal 82dBm 13MHz Maximum input signal level correct operation (low gain) Image suppression Co-channel rejection Relative frequency error required IEEE 802.15.4) Relative timing error required IEEE 802.15.4) Linear RSSI range
13/88
Electrical characteristics
SN260
4.6.2
Note:
Transmit
Table lists parameters integrated IEEE 802.15.4 transmitter SN260. Transmit measurements were collected with Ember's EM260 reference design 2440MHz. Typical number indicates standard deviation below mean. Transmit characteristics
Parameter Test conditions highest power setting highest power setting lowest power setting defined IEEE 802.15.4, which sets maximum 3.5MHz away 3.5MHz away Min. Typ. Max. Unit
Table
Maximum output power (boost mode) Maximum output power Minimum output power Error vector magnitude Carrier frequency error Load impedance mask relative mask absolute
4.6.3
Synthesizer
Table lists parameters integrated synthesizer SN260.
Table
Parameter
Synthesizer characteristics
Test conditions Min. 2400 11.7 From off, with correct setting Channel change RX/TX turnaround (IEEE 802.15.4 defines 192s turnaround time) Typ. Max. 2500 Unit dBc/Hz dBc/Hz dBc/Hz dBc/Hz
Frequency range Frequency resolution Lock time Relock time Phase noise 100kHz Phase noise 1MHz Phase noise 4MHz Phase noise 10MHz
14/88
SN260
Functional description
Functional description
SN260 connects Host micro controller through standard interface. EmberZNet Serial Protocol (EZSP) been defined allow application written host micro controller choice. Therefore, SN260 comes with license EmberZNet, ZigBee-compliant software stack. following brief description hardware modules provides necessary background operation SN260. more information, contact your local sales representative.
Receive (RX) path
SN260 path spans analog digital domains. architecture based low-IF, super-heterodyne receiver. utilizes differential signal paths minimize noise interference. input signal mixed down frequency 4MHz mixers. output mixers filtered combined prior being sampled 12Msps ADC. filtering within path been designed optimize coexistence SN260 with other 2.4GHz transceivers, such IEEE 802.11g Bluetooth.
5.1.1
baseband
SN260 baseband (within digital domain) implements coherent demodulator optimal performance. baseband demodulates O-QPSK signal chip level synchronizes with IEEE 802.15.4-2003 preamble. Once packet preamble detected, de-spreads demodulated data into 4-bit symbols. These symbols buffered passed hardware-based module filtering. addition, baseband provides calibration control interface analog modules, including LNA, Baseband Filter, modulation modules. EmberZNet software includes calibration algorithms which this interface reduce effects process temperature variation.
5.1.2
RSSI
SN260 calculates RSSI over 8-symbol period well received packet. utilizes gain settings output level within algorithm. SN260 baseband provides support IEEE 802.15.4-2003 required methods summarized Table Modes defined 802.15.4-2003 standard; Mode proprietary mode. Table
mode
mode behavior
Mode behavior Clear channel reports busy medium either carrier sense RSSI exceeds their thresholds. Clear channel reports busy medium RSSI exceeds threshold. Clear channel reports busy medium carrier sense exceeds threshold. Clear channel reports busy medium both RSSI carrier sense exceed their thresholds.
15/88
Functional description
SN260
Transmit (TX) path
SN260 transmitter utilizes both analog circuitry digital logic produce O-QPSK modulated signal. area-efficient architecture directly modulates spread symbols prior transmission. differential signal paths increase noise immunity provide common interface external balun.
5.2.1
baseband
SN260 baseband (within digital domain) performs spreading 4-bit symbol into IEEE 802.15.4-2003-defined 32-chip sequence. addition, provides interface software perform calibration module order reduce process, temperature, voltage variations.
5.2.2
TX_ACTIVE signal
Even though SN260 provides output power suitable most ZigBee applications, some applications will require external power amplifier (PA). timing requirements IEEE 802.15.4-2003, SN250 provides signal, TX_ACTIVE, used external power management Switching logic. When Baseband drives TX_ACTIVE high described inTable When TX_ACTIVE signal low. external required, then TX_ACTIVE signal should connected through 100k resistor, shown application circuit Figure
Integrated module
SN260 integrates critical portions IEEE 802.15.4-2003 requirements hardware. This allows SN260 provide greater bandwidth application network operations. addition, hardware acts first-line filter non-intended packets. SN260 utilizes interface memory further reduce overall micro controller interaction when transmitting receiving packets. When packet ready transmission, software configures indicating packet buffer location. waits backoff period, then transitions baseband mode performs channel assessment. When channel clear, reads data from buffer, calculates CRC, provides 4-bit symbols baseband. When final byte been read sent baseband, remainder read transmitted. resides mode most time, different format address filters keep non-intended packets from using excessive buffers, well preventing SN260 from being interrupted. When reception packet begins, reads 4-bit symbols from baseband calculates CRC. assembles received data storage buffer. provides direct access memory. Once packet been received, additional data appended packet buffer space. appended data provides statistical information packet software stack.
16/88
SN260 primary features are:
Functional description
generation, appending, checking Hardware timers interrupts achieve symbol timing Automatic preamble, pre-pended packet Address recognition packet filtering received packets Automatic acknowledgement transmission Automatic transmission packets from memory Automatic transmission after backoff time channel clear (CCA) Automatic acknowledgement checking Time stamping received transmitted messages Attaching packet information received packets (LQI, RSSI, gain, time stamp, packet status) IEEE 802.15.4-2003 timing slotted/unslotted timing
Packet trace interface (PTI)
SN260 integrates true PHY-level effective network-level debugging. This twosignal interface monitors packets non-intrusive manner) between baseband modules. asynchronous 500kbps interface cannot used inject packets into PHY/MAC interface. signals from SN260 frame signal (PTI_EN) data signal (PTI_DATA). supported InSight Desktop.
16-bit microprocessor
SN260 integrates XAP2b microprocessor developed Cambridge Consultants Ltd., making true network processor solution. XAP2b 16-bit Harvard architecture processor with separate program data address spaces. word width bits both program data sides. standard XAP2 microprocessor accompanying software tools have been enhanced create XAP2b microprocessor used SN260. XAP2b adds data-side byte addressing support XAP2 allowing more productive usage optimized code. XAP2b clock speed 12MHz. When used with EmberZNet stack, firmware loaded into Flash memory over serial link using built-in bootloader reserved area Flash. Alternatively, firmware loaded interface with assistance RAM-based utility routines also loaded SIF.
Embedded memory
SN260 contains embedded Flash memory firmware storage execution. addition partitions portion Flash simulated EEPROM token storage.
17/88
Functional description
SN260
5.6.1
Simulated EEPROM
protocol stack reserves section Flash memory provide simulated EEPROM storage area stack customer tokens. Flash cell been qualified data retention time >100 years room temperature rated have guaranteed 1,000 write/erase cycles. Because Flash cells qualified 1,000 write cycles, simulated EEPROM implements effective wear-leveling algorithm which effectively extends number write cycles individual tokens. number set-token operations finite write cycle limitation Flash. possible guarantee exact number set-token operations because life simulated EEPROM depends which tokens written often. SN260 stores non-volatile information necessary network operation well tokens available Host (see section Section 7.2.6: Tokens page 37). majority internal tokens only written when SN260 performs network join leave operation. simple estimate possible set-token operations, consider SN260 stable network joins leaves) sending messages where Host uses only 8-byte tokens available Under this scenario, very rough estimate results approximately 330,000 possible set-token operations. number possible set-token calls, though, depends which tokens being set, ratios set-token calls each token plays large factor. very rough estimate total number times token approximately 320,000. These estimates would typically increase SN260 kept closer room temperature, since 1,000 guaranteed write cycles Flash across temperature.
5.6.2
Flash information area (FIA)
SN260 also includes separate 1024-byte that used storage data during manufacturing, including serial numbers calibration values. Programming this special Flash page only enabled using interface prevent accidental corruption erasure. EmberZNet stack reserves small portion this space addition makes eight manufacturing tokens available application. Section 7.2.6: Tokens page more information.
Encryption accelerator
SN260 contains hardware encryption engine that attached using memory-mapped interface. NIST-based CCM, CCM*, CBC-MAC, modes implemented hardware. These modes described IEEE 802.15.4-2003 specification, with exception CCM*, which described ZigBee Security Services Specification 1.0. EmberZNet stack implements security applications that require security application level.
18/88
SN260
Functional description
Reset detection
SN260 contains multiple reset sources. reset event logged into reset source register, which lets determine cause last reset. following reset causes detected:
Power-on-reset Watchdog rollover Software reset Core power
Power-on-reset (POR)
Each voltage domain (1.8V digital core supply VDD_CORE pads supply VDD_PADS) power-on-reset (POR) cell. VDD_PADS cell holds always-powered high-voltage domain reset until following conditions have been met:
high-voltage pads supply VDD_PADS voltage rises above threshold. internal clock starts generates three clock pulses. 1.8V cell holds main digital core reset until regulator output voltage rises above threshold.
Additionally, digital domain counts 1,024 clock edges 24MHz crystal before releasing reset main digital core. Table lists features SN260 circuitry. Table specifications
Parameter VDD_PADS release VDD_PADS assert 1.8V release 1.8V hysteresis Min. 1.35 0.08 Typ. Max. 1.65 0.12 Unit
5.10
Clock sources
SN260 integrates oscillators: high-frequency 24MHz crystal oscillator lowfrequency internal 10kHz oscillator.
5.10.1
High-frequency crystal oscillator
integrated high-frequency crystal oscillator requires external 24MHz crystal with accuracy ±40ppm. Based upon application bill materials current consumption requirements, external crystal cover range requirements. lower ESR, cost crystal increases overall current consumption decreases. Likewise, higher ESR, cost decreases current consumption increases. Therefore, designer choose crystal needs application.
19/88
Functional description Table lists specifications high-frequency crystal. Table High-frequency crystal specifications
Test conditions Min. Typ. Initial, temperature, aging Load capacitance 10pF Load capacitance 18pF Good crystal: ESR, 10pF load Worst-case crystals (60, 18pF 100, 10pF) maximum bias Max.
SN260
Parameter Frequency Duty cycle Phase noise from 1kHz 100kHz Accuracy Crystal Crystal Start-up time stable clock (max. bias) Start-up time stable clock (optimum bias) Current consumption Current consumption Current consumption
Unit dBc/Hz
5.10.2
Internal oscillator
SN260 low-power, low-frequency oscillator that runs time. nominal frequency 10kHz. divided down 1kHz using variable divider allow software accurately calibrate This calibrated clock used sleep timer. Time-keeping accuracy depends temperature fluctuations chip exposed power supply impedance, calibration interval, general will better than 150ppm (including crystal error 40ppm). Table lists specifications oscillator. Table oscillator specifications
Parameter Frequency Analog trim steps Frequency variation with supply voltage drop from 3.6V 3.1V 2.6V 2.1V Test conditions Min. Typ. 0.75 Max. Unit
20/88
SN260
Functional description
5.11
Random number generator
SN260 allows generation random numbers exposing randomly generated from ADC. Analog noise current passed through path, sampled receive ADC, stored register. value contained this register could used seed software-generated random number. EmberZNet stack utilizes these random numbers seed random backoff encryption generators.
5.12
Watchdog timer
SN260 contains internal watchdog timer clocked from internal oscillator. timer reaches time-out value approximately seconds, will reset SN260. This reset signal cannot routed externally Host. SN260 firmware will periodically restart watchdog timer while firmware running normally. Host cannot effect configure watchdog timer.
5.13
Sleep timer
16-bit sleep timer contained always-powered digital block. clock source sleep timer calibrated 1kHz clock. frequency slowed down with prescaler generate final timer resolution 1ms. With tick 16-bit timer, timer wraps about every 65.5 seconds. EmberZNet stack appropriately handles timer wraps allowing Host order theoretical maximum sleep delay million seconds.
5.14
Power management
SN260 supports four different power modes: active, idle, deep sleep, power down. Active mode normal, operating state SN260. While idle mode, code execution halts until interrupt occurs. modules SN260 including radio continue operate normally. EmberZNet stack automatically invokes idle appropriate. Deep sleep mode power down mode both power most SN260, including radio, leave only critical chip functions powered. internal regulator disabled VREG_OUT turned off. output signals maintained frozen state. Upon waking from deep sleep power down mode, internal regulator re-enabled. Deep sleep power down result same sleep current consumption. sleep modes differ follows: SN260 wake both internal timer external signal from deep sleep mode; power down mode only wake external signal.
21/88
protocol
SN260
protocol
SN260 level protocol centers interface communication with pair GPIO handshake signaling.
SN260 looks like hardware peripheral. SN260 slave device transactions initiated Host (the master). SN260 supports reasonably high data rate.
Physical interface configuration
SN260 supports both Slave Mode (clock idle low, sample rising edge) Slave Mode (clock idle high, sample rising edge) maximum clock rate 5MHz, illustrated Figure
Note:
convention waveforms this document show Mode Figure transfer format, Mode Mode
nHOST_INT signal nWAKE signal both active low. Host must supply pull-up resistor nHOST_INT signal prevent errant interruptions during undefined events such SN260 resetting. SN260 supplies internal pull-up nWAKE signal prevent errant interruptions during undefined events such Host resetting.
transaction
basic SN260 transaction half-duplex ensure proper framing give SN260 adequate response time. basic transaction, shown Figure composed three sections: Command, Wait, Response. transaction considered analogous function call. Command section function call, Response section return value. Figure General timing diagram transaction
22/88
SN260
protocol
6.2.1
Command section
Host begins transaction asserting Slave Select then sending command SN260. This command length from bytes must begin with 0xFF. During Command section, SN260 will respond with only 0xFF. Host should ignore data MISO during Command section. Once Host completed transmission entire message, transaction moves Wait section.
6.2.2
Wait section
Wait section period time during which SN260 processing command performing other operations. Note that this section length time milliseconds. Because variable size Wait section, interrupt-driven polling-driven method suggested clocking opposed method. Since SN260 require milliseconds respond, long Host keeps Slave Select active, Host perform other tasks while waiting Response. determine when Response ready, methods:
Clock until SN260 transmits byte other than 0xFF. Interrupt falling edge nHOST_INT.
first method, clocking SPI, recommended simplicity implementing. During Wait section, SN260 will transmit only 0xFF will ignore incoming data until Response ready. When SN260 transmits byte other than 0xFF, transaction officially moved into Response section. Therefore, Host poll Response continuing clock transmitting 0xFF waiting SN260 transmit byte other than 0xFF. SN260 will also indicate that Response ready asserting nHOST_INT signal. falling edge nHOST_INT indication that Response ready. Once nHOST_INT signal asserts, nHOST_INT will return idle after Host begins clock data.
6.2.3
Response section
When SN260 transmits byte other than 0xFF, transaction officially moved into Response section. data format same format used Command section. response length from bytes will begin with 0xFF. Depending actual response, length response known from first second byte this length should used Host clock exactly correct number bytes. Once bytes have been clocked, allowable Host de-assert chip select. Since Host control clocking SPI, there ACKs similar signals needed back from Host because SN260 will assume Host could accept bytes being clocked SPI. After every transaction, Host must hold Slave Select high minimum 1ms. This timing requirement called inter-command spacing necessary allow SN260 process command become ready accept command.
6.2.4
Asynchronous signaling
When SN260 data send Host, will assert nHOST_INT signal. nHOST_INT signal designed edge-triggered signal opposed leveltriggered signal; therefore, falling edge nHOST_INT true indicator data availability. Host then responsibility initiate transaction SN260 output. Host should initiate this transaction soon possible prevent possible
23/88
protocol
SN260
backup data SN260. SN260 will de-assert nHOST_INT signal after receiving byte SPI. inherent latency SN260, timing when nHOST_INT signal returns idle vary between transactions. nHOST_INT will always return idle minimum 10µs before asserting again. SN260 more output available after transaction completed, nHOST_INT signal will assert again after Slave Select de-asserted Host must make another request.
6.2.5
Spacing
ensure that SN260 always able deal with incoming commands, minimum intercommand spacing defined 1ms. After every transaction, Host must hold Slave Select high minimum 1ms. Host must respect inter-command spacing requirement, SN260 will have time operate command; additional commands could result error conditions undesired behavior. nHOST_INT signal already asserted, Host allowed Wake handshake instead intercommand spacing determine SN260 ready accept command.
6.2.6
Waking SN260 from sleep
Waking SN260 involves simple handshaking routine illustrated Figure This handshaking ensures that Host will wait until SN260 fully awake ready accept commands from Host. SN260 already awake when handshake performed (such when Host resets SN260 already operating), handshake will proceed described below with effects.
Note:
wake handshake cannot performed nHOST_INT already asserted. Figure SN260 wake sequence
Waking SN260 involves following steps: Host asserts nWAKE. SN260 interrupts nWAKE exits sleep. SN260 performs operations needs will respond until ready accept commands. SN260 asserts nHOST_INT within 10ms nWAKE asserting. SN260 does assert nHOST_INT within 10ms nWAKE, valid Host consider SN260 unresponsive reset SN260. Host detects nHOST_INT assertion. Since assertion nHOST_INT indicates SN260 accept transactions, Host does need hold Slave Select high normally required minimum inter-command spacing. Host de-asserts nWAKE after detecting nHOST_INT assertion. SN260 will de-assert nHOST_INT within nWAKE de-asserting. After 25µs, change nHOST_INT will indication normal asynchronous (callback) event.
24/88
SN260
protocol
6.2.7
Error conditions
more different error conditions occur back back, only first error condition will reported Host possible report error). following error conditions that might occur with SN260.
Oversized EZSP frame transaction includes EZSP Frame, Length Byte cannot value greater than 125. SN260 detects length byte greater than 125, will drop incoming Command abort entire transaction. SN260 will then assert nHOST_INT after Slave Select returns Idle inform Host through error code Response section what happened. only Command problematic transaction dropped SN260, next Command also dropped, because responded with Oversized EZSP Frame Error Response.
Aborted transaction aborted transaction transaction where Slave Select returns Idle prematurely Protocol dropped transaction. most common reason Slave Select returning Idle prematurely Host unexpectedly resetting. transaction aborted, SN260 will assert nHOST_INT inform Host through error code Response section what happened. When transaction aborted, only does Command problematic transaction dropped SN260, next Command also gets dropped since responded with Aborted Transaction Error Response.
Missing frame terminator Every Command Response must terminated with Frame Terminator byte. SN260 will drop Command that missing Frame Terminator. SN260 will then immediately provide Missing Frame Terminator Error Response.
Long transaction Long Transaction error occurs when Host clocks many bytes. long inter-command spacing requirement met, this error condition should cause problem, since SN260 will send only 0xFF outside Response section well ignore incoming bytes outside Command section.
Unresponsive Unresponsive mean SN260 powered, fully booted yet, incorrectly connected Host, busy performing other tasks. Host must wait maximum length Wait section before consider SN260 unresponsive Command section. This maximum length milliseconds, measured from last byte sent Command Section. SN260 ever fails respond during Wait section, valid Host consider SN260 unresponsive reset SN260. Additionally, nHOST_INT does assert within 10ms nWAKE asserting during wake handshake, Host consider SN260 unresponsive reset SN260.
protocol timing
Figure illustrates critical timing parameters Protocol. These timing parameters result SN260's internal operation both constrain Host behavior characterize SN260 operation. parameters shown discussed elsewhere this document. Note that Figure drawn scale, provided illustrate where parameters measured.
25/88
protocol Figure protocol timing waveform
SN260
Table lists timing parameters protocol. These parameters illustrated Figure Table
Parameter
protocol timing parameters
Description Wake handshake, while awake Wake handshake, while asleep Wake handshake finish Reset pulse width Startup time nHOST_INT de-asserting after Command Clock rate Wait section nHOST_INT de-asserting after Response nHOST_INT asserting after transaction Inter-command spacing 200000 1500 Min. Typ. Max. Unit
Data format
data format, also referred command, same both Command section Response section. data format Protocol straightforward, illustrated Figure
Figure
protocol data format
total length command must exceed bytes. commands must begin with Byte. Some commands only bytes-that they contain Byte Frame Terminator only.
26/88
SN260
protocol Length Byte only included there information EZSP Frame (EmberZNet Serial Protocol Frame) Length Byte defines length just EZSP Frame. Therefore, command includes EZSP Frame, Length Byte have value from through overall command size will through bytes. Byte specific value indicating there EZSP Frame not, there EZSP Frame, then Length Byte expected. Error Byte used error responses provide additional information about error appears place length byte. This additional information described following sections. EZSP Frame contains data needed operating EmberZNet. EZSP Frame format explained Section EmberZNet serial protocol page Frame Terminator special control byte used mark command. Frame Terminator byte defined 0xA7 appended Commands Responses immediately after final data byte. purpose Frame Terminator provide known byte Protocol detect corrupt command. example, SN260 resets during Response Section, Host will still clock correct number bytes. when host attempts verify value 0xA7 Response, will either value 0x00 0xFF know that SN260 just reset corrupt Response should discarded.
Note:
Length Byte only specifies length EZSP Frame. does include Frame Terminator.
Table
Command value
byte
Table lists possible commands their responses Byte. commands responses
Command Response value 0x00 0x01 0x02 Response SN260 reset occurred-This never used another response; always indicates SN260 Reset. Oversized EZSP Frame received-This never used another response; always indicates overflow occurred. Aborted Transaction occurred-This never used another response; always indicates aborted transaction occurred. Missing Frame Terminator-This never used another response; always indicates missing frame terminator command. Reserved [none] bit[7] always set. bit[6] always cleared. bit[5:0] number from 1-63. [none] EZSP frame Invalid
0x00 0x0F 0x0A 0x0B 0xF0 0xFD 0xFE 0xFF
Reserved Protocol Version Status Reserved EZSP Frame Invalid
0x03 0x04 [none] 0x81 0xBF
0xC0 0xC1 bit[7] always set. bit[6] always set. bit[0]-Set Alive. [none] 0xFE 0xFF
27/88
protocol
SN260
6.5.1
Primary bytes
There three primary bytes: protocol version, status, EZSP frame.
protocol version [0x0A] Sending this command requests Protocol Version number from Interface. response will always have cleared. this current version, response will 0x81, because version number corresponding this Command-Response values version number version number value from (0x81-0xBF).
status [0x0B] Sending this command asks SN260 status. response status byte will always have upper bits set. this current version, status byte only status [0], which SN260 alive ready commands.
EZSP frame [0xFE] This byte indicates that current transaction EZSP transaction there more data follow. This Byte, only this Byte, will cause transaction look like full data format illustrated Figure byte immediately after this Byte will Length Byte, used identify length EZSP Frame. EZSP Frame defined section Section EmberZNet serial protocol page Byte 0xFE, means minimum transaction size five bytes. other Bytes mean transaction size three bytes.
6.5.2
Special response bytes
There only five Byte values, 0x00-0x04, ever used error codes (see Table 16). When error condition occurs, command sent SN260 will ignored responded with these codes. These special Bytes must trapped dealt with. addition, each error condition Error Byte (instead Length Byte) also sent with Byte.
Table
byte value 0x00
Byte values used error codes
Error message Error description Section 6.6: Powering power cycling, rebooting. command contained EZSP frame with Length Byte greater than 125. SN260 forced drop entire command. transaction completed properly SN260 forced abort transaction. Error byte description reset type. Refer documentation discussing EmberResetType. Reserved
SN260 Reset
0x01
Oversized EZSP Frame Aborted Transaction Missing Frame Terminator Reserved
0x02
Reserved
0x03 0x04
command missing Frame Terminator. SN260 forced drop Reserved entire command. [none] [none]
28/88
SN260
protocol
Powering power cycling, rebooting
When Host powers reboots), cannot guarantee that SN260 awake ready receive commands. Therefore, Host should always perform Wake SN260 handshake guarantee that SN260 awake. SN260 resets, needs inform Host that Host reconfigure stack needed. When SN260 resets, will assert nHOST_INT signal, telling Host that data. Host should request data from SN260 usual. SN260 will ignore whatever command sent respond only with bytes. first byte will always 0x00 second byte will reset type defined EmberResetType. This specialty Byte never used another Response Byte. Host sees 0x00 from SN260, knows that SN260 been reset. SN260 will de-assert nHOST_INT signal shortly after receiving byte process further commands usual manner. addition Host having control reset line SN260, EmberZNet Serial Protocol also provides mechanism software reboot.
6.6.1
Unexpected resets
SN260 designed protect itself against undefined behavior unexpected resets. protection based state Slave Select since inter-command spacing mandates that Slave Select must return idle. SN260's internal Protocol uses Slave Select returning idle trigger re-initialize Protocol. always reinitializing, SN260 protected against Host unexpectedly resetting terminating transaction. Additionally, Slave Select active when SN260 powers SN260 will ignore data until Slave Select returns idle. ignoring traffic until idle, SN260 will begin receiving middle transaction. Host resets, most cases should reset SN260 well that both devices once again same state: freshly booted. Alternately, Host attempt recover from reset recovering previous state resynchronizing with state SN260. SN260 resets during transaction, Host expect either Wait Section timeout missing Frame Terminator indicating invalid Response. SN260 resets outside transaction, Host should proceed normally.
Transaction examples
This section contains following transaction examples:
protocol version EmberZNet serial protocol frame command SN260 reset Three-part transaction: Wake, Version, Stack Status Callback
29/88
protocol
SN260
6.7.1
protocol version
Figure protocol version example
Activate Slave Select (nSSEL). Transmit command 0x0A Protocol Version Request. Transmit Frame Terminator, 0xA7. Wait nHOST_INT assert. Transmit receive 0xFF until byte other than 0xFF received. Receive response 0x81 byte other than 0xFF), then receive Frame Terminator, 0xA7. always always cleared Version Response, this Version De-activate Slave Select.
6.7.2
EmberZNet serial protocol frame command
Figure EmberZNet serial protocol frame command example
Activate Slave Select (nSSEL). Transmit appropriate command: 0xFE: Byte indicating EZSP Frame 0x02: Length Byte showing EZSP Frame bytes long 0x00: EZSP Frame Control Byte indicating command with sleeping 0x05: EZSP Frame Type Byte indicating command 0xA7: Frame Terminator
Wait nHOST_INT assert. Transmit receive 0xFF until byte other than 0xFF received. Receive response 0xFE byte other than 0xFF) read next byte length.
30/88
SN260
protocol Stop transmitting after number bytes (length) received plus Frame Terminator. Decode response: 0xFE: Byte indicating EZSP Frame 0x02: Length Byte showing EZSP Frame bytes long 0x80: EZSP Frame Control Byte indicating response with overflow 0x05: EZSP Frame Type Byte indicating response 0xA7: Frame Terminator
De-activate Slave Select.
6.7.3
SN260 reset
Figure SN260 reset example
nHOST_INT asserts. Activate Slave Select (nSSEL). Transmit command: 0xFE: Byte indicating EZSP Frame 0x02: Length Byte showing EZSP Frame bytes long 0x00: EZSP Frame Control Byte indicating command with sleeping 0x06: EZSP Frame Type Byte indicating callback command 0xA7: Frame Terminator
Wait nHOST_INT assert. Transmit receive 0xFF until byte other than 0xFF received. Receive response 0x00 byte other than 0xFF). Receive Error Byte decode (0x02 enumerated RESET_POWERON). Receive Frame Terminator (0xA7). Response 0x00 indicates SN260 reset Host should respond appropriately.
Deactivate Slave Select. Since nHOST_INT does assert again, there more data Host.
31/88
protocol
SN260
6.7.4
Three-part transaction: Wake, Version, Stack Status Callback
Figure Timing diagram three-part transaction
Activate nWAKE activate timeout timer. SN260 wakes already) awake enables communication. nHOST_INT asserts, indicating SN260 accept commands. Host sees nHOST_INT activation within 10ms deactivates nWAKE timeout timer. nHOST_INT de-asserts immediately after nWAKE. Activate Slave Select. Transmit Command 0x0A Protocol Version Request. Transmit Frame Terminator, 0xA7. Wait nHOST_INT assert.
Transmit receive 0xFF until byte other than 0xFF received. Receive response 0x81 byte other than 0xFF), then receive Frame Terminator, 0xA7. always always cleared Version Response, this Version Deactivate Slave Select. Host begins timing inter-command spacing preparation sending next command. nHOST_INT asserts shortly after deactivating Slave Select, indicating callback. Host sees nHOST_INT, waits before responding. Activate Slave Select. Transmit command: 0xFE: Byte indicating EZSP Frame 0x02: Length Byte showing EZSP Frame bytes long 0x00: EZSP Frame Control Byte indicating command with sleeping 0x06: EZSP Frame Type Byte indicating callback command 0xA7: Frame Terminator
Wait nHOST_INT assert. Transmit receive 0xFF until byte other than 0xFF received. Receive response 0xFE byte other than 0xFF), read next byte length. Stop transmitting after number bytes (length) received plus Frame Terminator.
32/88
SN260 Decode response: 0xFE: Byte indicating EZSP Frame 0x03: Length Byte showing EZSP Frame bytes long
protocol
0x80: EZSP Frame Control Byte indicating response with overflow 0x19: EZSP Frame Type Byte indicating emberStackStatusHandler command 0x91: EmberStatus EMBER_NETWORK_DOWN from emberStackStatusHandler 0xA7 Frame Terminator
Deactivate Slave Select. Since nHOST_INT does assert again, there more data Host.
33/88
EmberZNet serial protocol
SN260
EmberZNet serial protocol
EmberZnet Serial Protocol (EZSP) designed very familiar customers have used EmberZNet stack API. majority commands responses functionally identical those found EmberZNet 2.x. variations mainly timing differences running application separate processor across serial interface. Communication between SN260 Host consists two-message transaction. Host sends command message SN260 then SN260 sends response message Host. SN260 needs communicate asynchronously with Host, will indicate this using interrupt line then waiting Host send callback command. EZSP frames begin with Frame Control Byte followed Frame Byte. format rest frame depends frame Section 7.3: Protocol format page defines format frame IDs. Most frames have fixed length. few, such those containing application messages, variable length. frame control indicates direction message (command response). commands, frame control also contains power management information, responses also contains status information. When command contains application message, Host must supply one-byte tag. This used future commands responses refer message. example, when sending message, Host provides both message contents tag. then used report fate message later response from SN260.
Byte order
multiple octet fields transmitted received with least significant octet first, also referred little endian. This same byte order convention specified 802.15.4 ZigBee. Note that EUI64 fields treated 64-bit number therefore transmitted received little endian order. Each individual octet transmitted with most significant first, shown Section 6.1: Physical interface configuration page
Conceptual overview
This section provides overview concepts that specific SN260 that differ from EmberZNet stack API. commands responses mentioned this overview described more detail later this document.
7.2.1
Stack configuration
Host version command obtain information about firmware running SN260. There number configuration values that affect behavior stack. Host read these values time using getConfigurationValue command. After SN260 reset, Host modify default values using setConfigurationValue command. Host must then provide information about application endpoints using addEndpoint command. Table gives minimum, default maximum values each configuration values. Also listed cost. This number bytes additional required increase configuration value one. Since total amount fixed,
34/88
SN260
EmberZNet serial protocol additional required must made available reducing other configuration values.
Table
Configuration values
Value Min. Def. Max. Units packet buffers neighbors Cost Description number packet buffers available stack. maximum number router neighbors stack keep track neighbor node within radio range. maximum number datagram sequenced messages stack have process being either transmitted received given time. maximum number bindings supported stack. includes bindings EEPROM RAM. number binding table entries RAM. number binding table entries that concurrently support open sequenced connection. maximum number destinations which node route messages. This include both messages originating this node those relayed others. number simultaneous route discoveries that node will support. End-device child endpoints larger than this value will have their discovery information cached their router parent. size entry device discovery cache router. Endpoint descriptions longer than this will cached. number entries discovery cache router. Each device child requires entries. cache held EEPROM. Specifies stack profile. security level used security network layers. supported values security) (payload encrypted four-byte used authentication). maximum number hops message. maximum number device children that router will support. maximum amount time that will hold message indirect transmission child.
EZSP_CONFIG_PACKET_BUFFER_ COUNT EZSP_CONFIG_NEIGHBOR_TABLE_ SIZE
EZSP_CONFIG_TRANSPORT_ PACKET_COUNT
messages
EZSP_CONFIG_BINDING_ TABLE_SIZE EZSP_CONFIG_TEMPORARY_ BINDING_ENTRIES EZSP_CONFIG_TRANSPORT_ CONNECTION_COUNT
entries
entries
entries
EZSP_CONFIG_ROUTE_ TABLE_SIZE EZSP_CONFIG_DISCOVERY_ TABLE_SIZE EZSP_CONFIG_DISCOVERY_ CACHE_ENDPOINTS
entries
entries
endpoints
EZSP_CONFIG_DISCOVERY_ CACHE_ENTRY_SIZE
bytes
EZSP_CONFIG_DISCOVERY_ CACHE_SIZE EZSP_CONFIG_STACK_PROFILE
entries
EZSP_CONFIG_SECURITY_LEVEL
EZSP_CONFIG_MAX_HOPS EZSP_CONFIG_MAX_END_DEVICE_ CHILDREN EZSP_CONFIG_INDIRECT_ TRANSMISSION_TIMEOUT
hops children milliseconds
3000 30000
35/88
EmberZNet serial protocol
Table Configuration values (continued)
Value Min. Def. Max. Units Cost Description
SN260
EZSP_CONFIG_RESERVED_ ROUTING_ENTRIES
entries
number route table entries that reserved temporary aggregation routes mesh stack. maximum amount time that mobile node wait between polls. poll heard within this timeout, then parent removes mobile node from tables. number child table entries reserved only mobile nodes. amount available Host. Enables boost power mode and/or alternate transmitter output.
EZSP_CONFIG_MOBILE_NODE_ POLL_TIMEOUT EZSP_CONFIG_RESERVED_ MOBILE_CHILD_ENTRIES EZSP_CONFIG_HOST_RAM EZSP_CONFIG_TX_POWER_MODE
quarter seconds
entries bytes
7.2.2
Policy settings
There some situations when SN260 must make decision there isn't enough time consult with Host. Host control what decision made setting policy advance. SN260 will then make decisions according current policy. Host informed callbacks each time decision made, time news reaches Host, late change that decision. change policies time using setPolicy command. policy used trust center behavior, external binding modification requests, datagram replies, generating pollHandler callbacks, contents unicastSent messageSent callbacks.
7.2.3
Datagram replies
policy datagram replies allows Host decide whether wants supply SN260 with reply payload every datagram received. Host sets policy supply reply, SN260 will automatically send empty reply (containing payload) every datagram received. Host sets policy supply reply, then SN260 will only send reply when instructed Host. reply does reach sender before transport retry timeout expires, sender will transmit datagram again. Host must process incoming message supply reply quickly enough avoid retransmission sender. Provided this timing constraint met, multiple datagrams received before first reply supplied replies supplied order.
7.2.4
Callbacks
Asynchronous callbacks from SN260 sent Host response callback command. SN260 uses interrupt line indicate that Host should send callback command. SN260 will queue multiple callbacks while waits Host, each response only delivers callback. SN260 receives callback command when there pending callbacks, will reply with noCallbacks response.
36/88
SN260
EmberZNet serial protocol
7.2.5
Power management
SN260 will always idle processor whenever possible. further reduce power consumption, SN260 sleep Host. power down mode, only external interrupt will wake SN260. deep sleep mode, SN260 will internal timer wake scheduled events. SN260 provides independent timers that Host purpose, including waking SN260 from deep sleep mode. Timers using setTimer command generate timerHandler callbacks. initial frame control byte every command tells SN260 which sleep mode enter after responded command. Including this information every command (instead having separate power management command) allows SN260 sleep faster. Host needs SN260 sleep without also performing another action, command used. deep sleep mode, SN260 will wake internal event. event does produce callback Host, SN260 will back sleep once event been handled. event does produce callback, SN260 will signal Host remain awake waiting callback command. frame control byte callback command specifies deep sleep mode, then SN260 would normally back sleep after responding with callback. However, there second callback pending, SN260 will remain awake waiting another callback command. avoid disrupting operation network, only SN260 sleep when joined network when joined sleeping device. SN260 joined sleeping device, then must poll parent order receive messages. Host controls polling behavior using pollForData command. Polls sent periodically with interval Host single poll sent. result every poll attempt optionally reported using pollCompleteHandler callback.
7.2.6
Tokens
Some non-volatile storage SN260 made available Host. manufacturing tokens stored flash information area read using getMfgToken command tokens stored simulated EEPROM read written using setToken getToken commands. Each token bytes. Tokens preserve their values between reboots. Refer section Simulated EEPROM description simulated EEPROM write cycle estimates.
7.2.7
Some SN260 reserved Host use. amount space reserved EZSP_CONFIG_HOST_RAM configuration value (set using setConfigurationValue command). Host then read write data using setRam getRam commands. Host chooses reserve RAM, this will reduce number messages callbacks that SN260 buffer.
37/88
EmberZNet serial protocol
SN260
7.2.8
SN260 status
frame control byte every response sent SN260 contains status bits:
overflow SN260 memory time since previous response sent. this set, then messages have been lost. truncated SN260 truncated current response. this set, command from Host produced response larger than maximum EZSP frame length.
command check status SN260 without also performing another action.
7.2.9
Random number generator
Host obtain random number from SN260 using getRandomNumber command. random number generated from analog noise radio used seed random number generator Host.
Protocol format
EZSP frames begin with frame control byte. Table describes meaning this byte command response frames. Table describes sleep modes, Table describes overflow status Table describes truncated status bit. second byte EZSP frames frame byte. Table
(MSB) (LSB)
Frame control byte
Command (reserved) (reserved) (reserved) (reserved) (reserved) sleepMode[1] sleepMode[0] Sleep modes sleepMode[0] Description Reserved. Power down. Deep sleep. Idle. Response (reserved) (reserved) (reserved) (reserved) (reserved) truncated overflow
Table
sleepMode[1]
38/88
SN260 Table Overflow status
Description
EmberZNet serial protocol
overflow
SN260 memory since previous response. memory shortage since previous response.
Table
Truncated status
Description SN260 truncated current response avoid exceeding maximum EZSP frame length. current response truncated.
truncated
Section 7.3.1: Type definitions defines types used SN260 Section 7.3.2: Structure definitions defines structures. Section 7.3.3: Named values enumerates named values different types. subsequent sections list frames supported SN260, specifying Frame command parameters response parameters. list divided into five sections:
Section 7.3.4 lists Configuration frames. Section 7.3.5 lists Utilities frames. Section 7.3.6 lists Networking frames. Section 7.3.7 lists Binding frames. Section 7.3.8 lists Messaging frames.
Finally, section Section 7.3.9 provides alphabetical list frames.
39/88
EmberZNet serial protocol
SN260
7.3.1
Table
Type definitions
Type definitions
Type Alias int8u int8u int16u int8u int8u int8u int8u int8u int8u int8u int8u int8u int8u int8u int8u int16u int16u int8u[8] True false. Identifies configuration value. Values EZSP_CONFIG_TX_POWER_MODE. Return type configuration commands. Identifies policy. Identifies policy decision. Return type stack functions. Either marks event inactive specifies units event execution time. type node. possible join states node. Incoming message types. Binding types. Options when sending unicast message. Network scan types. Decision made trust center when node attempts join. 16-bit ZigBee network address. 802.15.4 64-bit IEEE address). Description
boolean EzspConfigId EzspConfigTxPowerMode EzspConfigStatus EzspPolicyId EzspDecisionId EmberStatus EmberEventUnits EmberNodeType EmberNetworkStatus EmberIncomingMessageType EmberBindingType EmberUnicastOption EmberNetworkScanType EmberJoinDecision EmberNodeId EmberPanId EmberEUI64
40/88
SN260
EmberZNet serial protocol
7.3.2
Table
Structure definitions
Structure definitions
Structure Field Description Network parameters.
EmberNetworkParameters
int16u panId int8s radioTxPower int8u radioChannel
network's identifier. power setting, dBm. radio channel. ZigBee frame parameters.
int16u profileId EmberApsFrame int8u clusterId int8u sourceEndpoint
application profile that describes format message. cluster this message. source endpoint.
int8u destinationEndpoint destination endpoint. EmberUnicastOption options bitmask options. entry binding table. EmberBindingType type int8u local int8u remote type binding. endpoint local node. endpoint remote node (specified identifier). cluster that matches from local endpoint's simple descriptor. This cluster provisioning application indicate which part endpoint's functionality bound this particular remote node used distinguish between unicast multicast bindings. binding used send messages with cluster just listed binding. 64-bit identifier. This either destination EUI64 (for unicasts) 64-bit group address (for multicasts).
EmberBindingTableEntry int8u clusterId
EmberEUI64 identifier
41/88
EmberZNet serial protocol
SN260
7.3.3
Table
Named values
boolean
Structure Field 0x00 0x01 Description alias zero, used clarity. alias one, used clarity.
FALSE TRUE
Table
EzspConfigId
Structure Field 0x01 0x02 Description number packet buffers available stack. maximum number router neighbors stack keep track neighbor node within radio range. maximum number datagram sequenced messages stack have 'in-flight' time. Here, 'in-flight' means process being either transmitted received'. maximum number bindings supported stack. includes bindings EEPROM RAM. number binding table entries RAM. number binding table entries that concurrently support open sequenced connection. maximum number destinations which node route messages. This include both messages originating this node those relayed others. number simultaneous route discoveries that node will support. End-device child endpoints larger than this value will have their discovery information cached their router parent. size entry device discovery cache router. Endpoint descriptions longer than this will cached. number entries discovery cache router. Each device child requires entries. cache held EEPROM. Specifies stack profile. security level used security network layers. supported values security) (payload encrypted four-byte used authentication). maximum number hops message. maximum number device children that router will support.
EZSP_CONFIG_PACKET_BUFFER_COUNT EZSP_CONFIG_NEIGHBOR_TABLE_SIZE
0x03
EZSP_CONFIG_BINDING_TABLE_SIZE RIES COUNT EZSP_CONFIG_ROUTE_TABLE_SIZE
0x04 0x05 0x06
0x07
INTS _SIZE
0x08
0x09
0x0A
0x0B
EZSP_CONFIG_STACK_PROFILE
0x0C
EZSP_CONFIG_SECURITY_LEVEL
0x0D
EZSP_CONFIG_MAX_HOPS
0x10 0x11
42/88
SN260 Table EzspConfigId (continued)
Structure TIMEOUT EZSP_CONFIG_RESERVED_ROUTING_ ENTRIES EZSP_CONFIG_MOBILE_NODE_POLL_ TIMEOUT ENTRIES EZSP_CONFIG_HOST_RAM EZSP_CONFIG_TX_POWER_MODE Field 0x12 0x13
EmberZNet serial protocol
Description maximum amount time that will hold message indirect transmission child. number route table entries that reserved temporary aggregation routes mesh stack. maximum amount time that mobile node wait between polls. poll heard within this timeout, then parent removes mobile node from tables. number child table entries reserved only mobile nodes. amount available Host. Enables boost power mode and/or alternate transmitter output.
0x14
0x15 0x16 0x17
Table
EzspConfigTxPowerMode
Structure Field 0x00 Description Normal power mode bi-directional transmitter output. Enable boost power mode. This high performance radio mode which offers increased receive sensitivity transmit power cost increase power consumption. Enable alternate transmitter output. This allows simplified connection external power amplifier RF_TX_ALT_P RF_TX_ALT_N pins. Enable both boost mode alternate transmitter output.
EMBER_TX_POWER_MODE_DEFAULT
EMBER_TX_POWER_MODE_BOOST
0x01
EMBER_TX_POWER_MODE_ALTERNATE EMBER_TX_POWER_MODE_BOOST_AND_ ALTERNATE
0x02
0x03
Table
EzspConfigStatus
Structure Field 0x00 0x01 0x02 0x03 0x04 Description command successful. Insufficient memory available. value bounds. configuration recognized. Configuration values longer modified.
EZSP_CONFIG_SUCCESS EZSP_CONFIG_OUT_OF_MEMORY EZSP_CONFIG_INVALID_VALUE EZSP_CONFIG_INVALID_TAG EZSP_CONFIG_INVALID_CALL
Table
EzspPolicyId
Structure Field 0x00 0x01 0x02 Description Controls trust center behavior. Controls external binding modification requests handled. Controls whether Host supplies datagram replies.
EZSP_TRUST_CENTER_POLICY EZSP_DATAGRAM_REPLIES_POLICY
43/88
EmberZNet serial protocol Table EzspPolicyId (continued)
Structure EZSP_POLL_HANDLER_POLICY _POLICY Field 0x03 0x04 Description Controls whether pollHandler callbacks generated.
SN260
Controls whether message contents included unicastSent messageSent callbacks.
Table
EzspDecisionId
Structure Field 0x00 Description EZSP_TRUST_CENTER_POLICY default decision. Only allow nodes that joining securely using network join. EZSP_TRUST_CENTER_POLICY decision. Allow nodes join, sending nodes that joining securely. EZSP_TRUST_CENTER_POLICY decision. Reject join attempts. EZSP_TRUST_CENTER_POLICY decision. Forward request trust center (this value should used trust center itself). default decision. allow local binding table changed remote nodes. decision. Allow remote nodes change local binding table. EZSP_DATAGRAM_REPLIES_POLICY default decision. SN260 will automatically send empty reply (containing payload) every datagram received. EZSP_DATAGRAM_REPLIES_POLICY decision. SN260 will only send reply receives sendReply command from Host. EZSP_POLL_HANDLER_POLICY default decision. inform Host when child polls. EZSP_POLL_HANDLER_POLICY decision. Generate pollHandler callback when child polls. default decision. Include only message unicastSent messageSent callbacks. decision. Include both message message contents unicastSent messageSent callbacks.
EZSP_ALLOW_SECURE_JOINS_ONLY
EZSP_ALLOW_ALL_JOINS
0x01
EZSP_DISALLOW_ALL_JOINS
0x02
EZSP_ASK_TRUST_CENTER
0x03
EZSP_ALLOW_BINDING_MODIFICATION
0x10
0x11
EZSP_HOST_WILL_NOT_SUPPLY_REPLY
0x20
EZSP_HOST_WILL_SUPPLY_REPLY
0x21
EZSP_POLL_HANDLER_IGNORE EZSP_POLL_HANDLER_CALLBACK
0x30 0x31
0x40
CALLBACK
0x41
44/88
SN260 Table EmberStatus
Structure EMBER_SUCCESS EMBER_ERR_FATAL EMBER_EEPROM_MFG_STACK_VERSION_ MISMATCH DEFINITIONS EMBER_EEPROM_STACK_VERSION_ MISMATCH EMBER_NO_BUFFERS EMBER_SERIAL_INVALID_BAUD_RATE EMBER_SERIAL_INVALID_PORT EMBER_SERIAL_TX_OVERFLOW EMBER_SERIAL_RX_OVERFLOW EMBER_SERIAL_RX_FRAME_ERROR EMBER_SERIAL_RX_PARITY_ERROR EMBER_SERIAL_RX_EMPTY EMBER_SERIAL_RX_OVERRUN_ERROR EMBER_MAC_TRANSMIT_QUEUE_FULL EMBER_MAC_UNKNOWN_HEADER_TYPE EMBER_MAC_SCANNING EMBER_MAC_NO_DATA EMBER_MAC_JOINED_NETWORK EMBER_MAC_BAD_SCAN_DURATION EMBER_MAC_INCORRECT_SCAN_TYPE EMBER_MAC_INVALID_CHANNEL_MASK EMBER_MAC_COMMAND_TRANSMIT_ FAILURE EMBER_MAC_NO_ACK_RECEIVED EMBER_MAC_INDIRECT_TIMEOUT Field 0x00 0x01 0x04
EmberZNet serial protocol
Description Generic error' message. Generic 'fatal error' message. Manufacturing stack token format non-volatile memory different than what stack expects (returned initialization). Static memory definitions ember-static-memory.h incompatible with this stack version. Manufacturing token format non-volatile memory different than what stack expects (returned initialization). Stack token format non-volatile memory different than what stack expects (returned initialization). There more buffers. Specified invalid baud rate. Specified invalid serial port. Tried send much data. There enough space store received character character dropped. Detected UART framing error. Detected UART parity error. There received data process. Receive interrupt handled time, character dropped. transmit queue full. header error receive. can't complete this task because scanning. pending data exists device doing data poll. Attempt scan when joined network. Scan duration must inclusive. Attempt made scan with incorrect duration value. emberStartScan called with incorrect scan type. emberStartScan called with invalid channel mask. Failed scan current channel because were unable transmit relevant command. expected receive following transmission, level never received. Indirect data message timed before polled.
0x05
0x06
0x07 0x18 0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 0x39 0x3A 0x3D 0x31 0x32 0x33 0x34 0x35 0x36
0x40 0x42
45/88
EmberZNet serial protocol Table EmberStatus (continued)
Structure Field Description
SN260
0x43
Simulated EEPROM telling application that there least flash page erased. GREEN status means current page filled above ERASE_CRITICAL_THRESHOLD. application should call function halSimEepromErasePage() when erase page. Simulated EEPROM telling application that there least flash page erased. status means current page filled above ERASE_CRITICAL_THRESHOLD. shrinking availability write space, there danger data loss. application must call function halSimEepromErasePage() soon possible erase page. Simulated EEPROM room write data data trying been lost. This error code result ignoring SIM_EEPROM_ERASE_PAGE_RED error code. application must call function halSimEepromErasePage() make room further calls token. fatal error occurred while trying write data Flash write verification failed. data flash cannot trusted after this error, possible this error result exceeding life cycles flash. Attempt initialize simulated EEPROM failed. This failure means information already stored Flash lack thereof), fatally incompatible with token information compiled into code image being run. Attempt initialize simulated EEPROM failed. This failure means Attempt failed, token system failed properly reload default tokens reset simulated EEPROM. Attempt initialize simulated EEPROM failed. This failure means both tokens TOKEN_MFG_NVDATA_VERSION TOKEN_STACK_NVDATA_VERSION were incorrect token system failed properly reload default tokens reset simulated EEPROM. unknown flash token specified. Could create flash token because already exists. incorrect size specified when retrieving token data. Couldn't write token because marked read-only. Bootloader received invalid message (failed attempt into bootloader).
EMBER_SIM_EEPROM_ERASE_PAGE_RED
0x44
EMBER_SIM_EEPROM_FULL
0x45
EMBER_SIM_EEPROM_FLASH_WRITE_ FAILED
0x46
EMBER_SIM_EEPROM_INIT_1_FAILED
0x47
EMBER_SIM_EEPROM_INIT_2_FAILED
0x48
EMBER_SIM_EEPROM_INIT_3_FAILED
0x49
EMBER_ERR_TOKEN_UNKNOWN EMBER_ERR_TOKEN_EXISTS EMBER_ERR_TOKEN_INVALID_SIZE EMBER_ERR_TOKEN_READ_ONLY EMBER_ERR_BOOTLOADER_TRAP_ TABLE_BAD
0x4B 0x4C 0x4D 0x4E 0x58
46/88
SN260 Table EmberStatus (continued)
Structure Field 0x59
EmberZNet serial protocol
Description Bootloader received invalid message (failed attempt into bootloader). Bootloader cannot complete bootload operation because either image found image exceeded memory bounds. limit been reached. connection either been opened already open. connection experienced catastrophic error. connection closed messages have been lost. Transport layer successfully closed connection. Transport layer process closing connection (waiting response from remote device). Transport layer attempted send deliver message, failed. This binding index range current binding table. Could find binding index given specified terminal. invalid binding table index given function. Multiple binding table entries were found specified terminal. call allowed given current state stack (for example, opening connection from sleepy node.). Link cost node known. Maximum number in-flight messages (such EMBER_TRANSPORT_PACKET_COUNT) been reached. connection open yet. Message transmitted into single over-the-air packet. Application trying delete overwrite binding that use. EUI64 available current packet. more sequenced messages failed received. Conversion complete. Conversion cannot done because request being processed. Conversion deferred until current request been processed. results pending.
EMBER_ERR_BOOTLOADER_NO_IMAGE
0x5A
EMBER_TOO_MANY_CONNECTIONS EMBER_CONNECTION_OPEN EMBER_CONNECTION_FAILED EMBER_CONNECTION_CLOSED EMBER_CONNECTION_CLOSING EMBER_DELIVERY_FAILED EMBER_INVALID_BINDING_TERMINAL EMBER_INVALID_BINDING_INDEX EMBER_TERMINAL_HAS_MULTIPLE_ BINDINGS EMBER_INVALID_CALL EMBER_COST_NOT_KNOWN EMBER_MAX_MESSAGE_LIMIT_REACHED EMBER_CONNECTION_NOT_YET_OPEN EMBER_MESSAGE_TOO_LONG EMBER_BINDING_IS_ACTIVE EMBER_EUI64_NOT_AVAILABLE LOST EMBER_ADC_CONVERSION_DONE EMBER_ADC_CONVERSION_BUSY EMBER_ADC_CONVERSION_DEFERRED EMBER_ADC_NO_CONVERSION_PENDING
0x60 0x61 0x63 0x64 0x65 0x66 0x69 0x6B 0x6C 0x6F 0x70 0x71 0x72 0x73 0x74 0x75 0x76 0x77 0x80 0x81 0x82 0x84
47/88
EmberZNet serial protocol Table EmberStatus (continued)
Structure EMBER_SLEEP_INTERRUPTED EMBER_PHY_TX_UNDERFLOW EMBER_PHY_TX_INCOMPLETE EMBER_PHY_INVALID_CHANNEL EMBER_PHY_INVALID_POWER EMBER_PHY_TX_BUSY Field 0x85 0x88 0x89 0x8A 0x8B 0x8C Description Sleeping (for duration) been abnormally interrupted exited prematurely. Transmit hardware buffer underflowed.
SN260
Transmit hardware finish transmitting packet. unsupported channel setting specified. unsupported power setting specified. Packet cannot transmitted because physical layer currently transmitting packet. (This used backoff algorithm.) software installed hardware doesn't recognize hardware radio type. software installed hardware doesn't recognize hardware radio type. receive entire packet expecting from radio. Stack software completed initialization ready send receive packets over air. Network operating. Network activity pending should shut down. Node joined network. attempt join network failed. chosen security level (the value EMBER_SECURITY_LEVEL) supported stack. After moving, mobile node's attempt re-establish contact with network failed. message cannot sent because network currently overloaded. datagram sent node EUI64 address datagram match node's EUI64 address. NodeId invalid. application tried send message using endpoint that defined. application tried binding that been remotely modified change been reported application. critical fatal error indicating that version stack trying does match with chip running software (stack) chip must replaced with software that compatible with chip.
EMBER_PHY_UNKNOWN_RADIO_TYPE EMBER_PHY_PARTIAL_PACKET EMBER_NETWORK_UP EMBER_NETWORK_DOWN EMBER_NETWORK_PENDING_ACTIVITY EMBER_NOT_JOINED EMBER_JOIN_FAILED EMBER_INVALID_SECURITY_LEVEL
0x8D 0x8E 0x8F 0x90 0x91 0x92 0x93 0x94 0x95
EMBER_MOVE_FAILED EMBER_NETWORK_BUSY
0x96 0xA1
EMBER_NODEID_INVALID
0xA2
EMBER_INVALID_ENDPOINT
0xA3
EMBER_BINDING_HAS_CHANGED
0xA4
0xB0
48/88
SN260 Table EmberEventUnits
Structure EMBER_EVENT_INACTIVE EMBER_EVENT_MS_TIME EMBER_EVENT_QS_TIME EMBER_EVENT_MINUTE_TIME Field 0x00 0x01 0x02 0x03
EmberZNet serial protocol
Description Event scheduled run. Execution time approximate milliseconds. Execution time 'binary' quarter seconds (256 approximate milliseconds each). Execution time 'binary' minutes (65536 approximate milliseconds each).
Table
EmberNodeType
Structure Field 0x01 0x02 0x03 0x04 0x05 Description Will relay messages parent other nodes. Will relay messages parent other nodes. Communicates only with parent will relay messages. device whose radio turned save power. application must poll receive messages. sleepy device that move through network.
EMBER_COORDINATOR EMBER_ROUTER EMBER_END_DEVICE EMBER_SLEEPY_END_DEVICE EMBER_MOBILE_END_DEVICE
Table
EmberNetworkStatus
Structure Field 0x00 0x01 0x02 0x03 0x04 Description node associated with network way. node currently attempting join network. node joined network. node device joined network parent responding. node process leaving current network.
EMBER_NO_NETWORK EMBER_JOINING_NETWORK EMBER_JOINED_NETWORK EMBER_JOINED_NETWORK_NO_PARENT EMBER_LEAVING_NETWORK
Table
EmberIncomingMessageType
Structure Field 0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 Datagram. Datagram reply. Sequenced message. Multicast. Shared multicast. Multicast loopback. Unicast. Broadcast. Description
EMBER_INCOMING_DATAGRAM EMBER_INCOMING_DATAGRAM_REPLY EMBER_INCOMING_SEQUENCED EMBER_INCOMING_MULTICAST EMBER_INCOMING_SHARED_MULTICAST 333EMBER_INCOMING_UNICAST EMBER_INCOMING_BROADCAST
49/88
EmberZNet serial protocol Table EmberBindingType
Structure EMBER_UNUSED_BINDING EMBER_UNICAST_BINDING EMBER_AGGREGATION_BINDING Field 0x00 0x01 0x02 Description binding that currently use. unicast binding whose 64-bit identifier destination EUI64. unicast binding whose 64-bit identifier aggregator EUI64.
SN260
EMBER_MULTICAST_BINDING
0x03
multicast binding whose 64-bit identifier group address. multicast binding used send messages group receive messages sent group.
Table
EmberUnicastOption Structure Field 0x00 0x04 0x10 0x40 0x80 0x20 0x01 options. Reserved. Reserved. Resend message using retry mechanism. Causes route discovery initiated route destination known. Causes route discovery initiated even known. Reserved. Description
EMBER_UNICAST_OPTION_NONE EMBER_UNICAST_OPTION_APS_RETRY DISCOVERY DISCOVERY EMBER_UNICAST_OPTION_POLL_ RESPONSE
Table
EmberNetworkScanType
Structure Field 0x00 0x01 Description energy scan scans each channel RSSI value. active scan scans each channel available networks.
EMBER_ENERGY_SCAN EMBER_ACTIVE_SCAN
Table
EmberJoinDecision
Structure Field 0x00 0x01 0x02 0x03 Description Allow node join. node key. Allow node join. Send node. Deny join. trust center.
EMBER_HAS_KEY EMBER_SEND_KEY EMBER_DENY_JOIN EMBER_ASK_TRUST_CENTER
50/88
SN260
EmberZNet serial protocol
7.3.4
Table
Configuration frames
version
0x00
Name: version
Description: command allows Host specify desired EZSP version. This document describes version protocol. response provides information about firmware running SN260. Command parameters: int8u desiredProtocolVersion Response parameters: int8u protocolVersion EZSP version SN260 using. SN260 does support version requested Host, will highest version does support. type stack running SN260. available EZSP commands their parameters depend stack type. mesh stack type version number stack. EZSP version Host wishes use.
int8u stackType int16u stackVersion
Table
getConfigurationValue
0x52
Name: getConfigurationValue
Description: Reads configuration value from SN260. Command parameters: EzspConfigId configId Response parameters: EzspConfigStatus status int16u value EZSP_CONFIG_SUCCESS value read successfully, EZSP_CONFIG_INVALID_ID SN260 does recognize configId. configuration value. Identifies which configuration value read.
Table
setConfigurationValue
0x53
Name: setConfigurationValue
Description: Writes configuration value SN260. Configuration values modified Host after SN260 reset. After stack status changes EMBER_NETWORK_UP, configuration values longer modified this command will respond with EZSP_CONFIG_INVALID_CALL. Command parameters: EzspConfigId configId int16u value Response parameters: EZSP_CONFIG_SUCCESS configuration value changed, EZSP_CONFIG_OUT_OF_MEMORY value exceeded available memory, EZSP_CONFIG_INVALID_VALUE value bounds, EZSP_CONFIG_INVALID_ID SN260 does recognize configId, EZSP_CONFIG_INVALID_CALL configuration values longer modified. Identifies which configuration value change. configuration value.
EzspConfigStatus status
51/88
EmberZNet serial protocol Table addEndpoint
0x02
SN260
Name: addEndpoint
Description: Configures endpoint information SN260. SN260 does remember these settings after reset. Endpoints added Host after SN260 reset. After stack status changes EMBER_NETWORK_UP, endpoints longer added this command will respond with EZSP_CONFIG_INVALID_CALL. Command parameters: int8u endpoint int16u profileId int16u deviceId int8u appFlags int8u inputClusterCount int8u outputClusterCount int8u[] inputClusterList int8u[] outputClusterList Response parameters: EZSP_CONFIG_SUCCESS endpoint added, EZSP_CONFIG_OUT_OF_MEMORY there enough memory available endpoint, EZSP_CONFIG_INVALID_VALUE endpoint already exists, EZSP_CONFIG_INVALID_CALL endpoints longer added. application endpoint added. endpoint's application profile. endpoint's device within application profile. device version flags indicating description availability. number input clusters. number output clusters. Input cluster endpoint will accept. Output cluster endpoint send.
EzspConfigStatus status
Table
setPolicy
0x55
Name: setPolicy
Description: Allows Host change policies used SN260 make fast decisions. Command parameters: EzspPolicyId policyId EzspDecisionId decisionId Response parameters: EzspConfigStatus status EZSP_CONFIG_SUCCESS policy changed, EZSP_CONFIG_INVALID_ID SN260 does recognize policyId. Identifies which policy modify. decision specified policy.
Table
getPolicy
0x56
Name: getPolicy
Description: Allows Host read policies used SN260 make fast decisions. Command parameters: EzspPolicyId policyId Identifies which policy read.
52/88
SN260 Table getPolicy (continued)
EmberZNet serial protocol
Response parameters: EzspConfigStatus status EzspDecisionId decisionId EZSP_CONFIG_SUCCESS policy read successfully, EZSP_CONFIG_INVALID_ID SN260 does recognize policyId. current decision specified policy.
7.3.5
Table
Name:
Utilities frames
0x05
Description: transaction which does nothing. Host this sleep mode check status SN260. Command parameters: None Response parameters: None
Table
invalidCommand
0x58
Name: invalidCommand
Description: Indicates that SN260 received command containing unsupported frame This frame response invalid command. Response parameters: None
Table
callback
0x06
Name: callback
Description: Allows SN260 respond with pending callback. Command parameters: None response this command callback responses.
Table
noCallbacks
0x07
Name: noCallbacks
Description: Indicates that there currently pending callbacks. This frame response callback command. Response parameters: None
Table
Name: reset
reset
0x08
Description: Allows Host reset SN260. Command parameters: None Response parameters: None
53/88
EmberZNet serial protocol Table setToken
0x09
SN260
Name: setToken
Description: Sets token bytes non-volatile storage) simulated EEPROM SN260. Command parameters: int8u tokenId int8u[8] tokenData Response parameters: EmberStatus status EmberStatus value indicating success reason failure. Which token data write token.
Table
getToken
0x0A
Name: getToken
Description: Retrieves token bytes non-volatile storage) from simulated EEPROM SN260. Command parameters: int8u tokenId Response parameters: EmberStatus status int8u[8] tokenData EmberStatus value indicating success reason failure. contents token. Which token read
Table
getMfgToken
0x0B
Name: getMfgToken
Description: Retrieves manufacturing token bytes non-volatile storage) from Flash Information Area SN260. Command parameters: int8u tokenId Response parameters: EmberStatus status int8u[8] tokenData EmberStatus value indicating success reason failure. contents manufacturing token. Which manufacturing token read
Table
setRam
0x46
Name: setRam
Description: Writes data supplied Host SN260. amount available Host must using setConfigurationValue command. parameters int8u startIndex int8u dataLength int8u[] data Response parameters: EmberStatus status EmberStatus value indicating success reason failure. location start writing data. length data parameter bytes. data write RAM.
54/88
SN260 Table getRam
0x47
EmberZNet serial protocol
Name: getRam
Description: Reads data from SN260 returns Host. Command parameters: int8u startIndex int8u length Response parameters: EmberStatus status int8u dataLength int8u[] data EmberStatus value indicating success reason failure. length data parameter bytes. data read from RAM. location start reading data. number bytes read.
Table
getRandomNumber
0x49
Name: getRandomNumber
Description: Returns random number, generated using noise from radio. Command parameters: None Response parameters: EmberStatus status int16u value EmberStatus value indicating success reason failure. status EMBER_SUCCESS, random number. Otherwise, zero.
Table
getMillisecondTime
0x0D
Name: getMillisecondTime
Description: Returns current time milliseconds according SN260's internal clock. Command parameters: None Response parameters: int32u time current time milliseconds.
Table
setTimer
0x0E
Name: setTimer
Description: Sets timer SN260. There independent timers available Host. timer cancelled setting time units EMBER_EVENT_INACTIVE. Command parameters: int8u timerId Which timer delay before timerHandler callback will generated. Note that timer clock free running synchronized with this command. This means that actual delay will between time (time maximum delay 32767. units time. true, timerHandler callback will generated repeatedly. false, only single timerHandler callback will generated.
int16u time
EmberEventUnits units boolean repeat
55/88
EmberZNet serial protocol Table setTimer (continued)
EmberStatus value indicating success reason failure.
SN260
Response parameters EmberStatus status
Table
getTimer
0x4E
Name: getTimer
Description: Gets information about timer. Host this command find much longer will before previously timer will generate callback. Command parameters: int8u timerId Response parameters: int16u time EmberEventUnits units boolean repeat delay before timerHandler callback will generated. units time. True timerHandler callback will generated repeatedly. False only single timerHandler callback will generated. Which timer information about
Table
timerHandler
0x0F
Name: timerHandler Description: callback from timer.
This frame response callback command. Response parameters: int8u timerId Which timer generated callback
Table
serialWrite
0x10
Name: serialWrite
Description: Sends serial message from Host InSight debug system SN260. Command parameters: int8u messageLength int8u[] messageContents Response parameters: EmberStatus status EmberStatus value indicating success reason failure. length messageContents parameter bytes. serial message.
56/88
SN260 Table serialRead
0x11
EmberZNet serial protocol
Name: serialRead
Description: Allows Host read serial message from InSight debug system SN260. Command parameters: int8u length Response parameters: int8u messageLength int8u[] messageContents length messageContents parameter bytes. serial message. maximum number bytes read.
Table
debugWrite
0x12
Name: debugWrite
Description: Sends debug message from Host InSight debug system SN260. Command parameters: boolean binaryMessage int8u messageLength int8u[] messageContents Response parameters: EmberStatus status EmberStatus value indicating success reason failure. TRUE message should interpreted binary data, FALSE message should interpreted ASCII text. length messageContents parameter bytes. binary message.
Table
debugHandler
0x13
Name: debugHandler
Description: Delivers binary message from InSight debug system Host SN260. This frame response callback command. Response parameters: int8u messageLength int8u[] messageContents length messageContents parameter bytes. binary message.
7.3.6
Table
Networking frames
setEncryptionKey
0x14
Name: setEncryptionKey
Description: Sets encryption used encrypt decrypt radio messages. This function does work stack already associated with network. Command parameters: int8u[16] int8u keySequenceNumber pointer 16-byte encryption key. sequence number associated with this key.
57/88
EmberZNet serial protocol Table setEncryptionKey (continued)
EmberStatus value indicating success reason failure.
SN260
Response parameters: EmberStatus status
Table
setManufacturerCode
0x15
Name: setManufacturerCode
Description: Sets manufacturer code specified value. manufacturer code fields node descriptor. Command parameters: int16u code Response parameters: None manufacturer code local node.
Table
setPowerDescriptor
0x16
Name: setPowerDescriptor
Description: Sets power descriptor specified value. power descriptor dynamic value, therefore should call this function whenever value changes. Command parameters: int16u descriptor Response parameters: None power descriptor local node.
Table
networkInit
0x17
Name: networkInit
Description: Resume network operation after reboot. node retains original type. This should called startup whether node previously part network. EMBER_NOT_JOINED returned node part network. Command parameters: None Response parameters: EmberStatus status EmberStatus value that indicates following: successful initialization, EMBER_NOT_JOINED node part network, reason failure.
Table
networkState
0x18
Name: networkState
Description: Returns value indicating whether node joining, joined leaving network. Command parameters: None Response parameters: EmberNetworkStatus status EmberNetworkStatus value indicating current join status.
58/88
SN260 Table stackStatusHandler
0x19
EmberZNet serial protocol
Name: stackStatusHandler
Description: callback invoked when status stack changes. status parameter equals EMBER_NETWORK_UP, then getNetworkParameters command called obtain network parameters. parameters being stored nonvolatile memory Host, stored values should updated. This frame response callback command. Response parameters: EmberStatus status Stack status. following: EMBER_NETWORK_UP, EMBER_NETWORK_DOWN, EMBER_JOIN_FAILED, EMBER_MOVE_FAILED
Table
startScan
0x1A
Name: startScan
Description: This function will start scan. Command parameters: EmberNetworkScanType scanType Indicates type scan performed. Possible values: EMBER_ENERGY_SCAN, EMBER_ACTIVE_SCAN. Bits indicate that this particular channel should scanned. Bits indicate that this particular channel should scanned. example, channelMask value 0x00000001 would indicate that only channel should scanned. Valid channels range from inclusive. This translates channel mask value 0x07FFF800. Sets exponent number scan periods, where scan period symbols. scan will occur ((2^duration) scan periods.
int32u channelMask
int8u duration Response parameters:
EmberStatus status
EMBER_SUCCESS signals that scan successfully started. Possible error responses their meanings: EMBER_MAC_SCANNING, already scanning; EMBER_MAC_JOINED_NETWORK, currently joined network begin scan; EMBER_MAC_BAD_SCAN_DURATION, have duration value that 0.14 inclusive; EMBER_MAC_INCORRECT_SCAN_TYPE, have requested undefined scanning type; EMBER_MAC_INVALID_CHANNEL_MASK, channel mask specify valid channels.
Table
energyScanResultHandler
0x48
Name: energyScanResultHandler
Description: Reports result energy scan single channel. scan complete until scanCompleteHandler callback called. This frame response callback command. Response parameters: int8u channel int8u maxRssiValue 802.15.4 channel number that scanned. maximum RSSI value found channel.
59/88
EmberZNet serial protocol Table networkFoundHandler
0x1B
SN260
Name: networkFoundHandler
Description: Reports that network found, gives network parameters useful deciding which network join. This frame response callback command. Response parameters: int8u channel int16u panId boolean expectingJoin int8u stackProfile 802.15.4 channel number which current network found. current network. Whether node that generated this beacon allowing additional children join network. ZigBee profile number current network.
Table
scanCompleteHandler
0x1C
Name: scanCompleteHandler
Description: Returns status current scan. EMBER_SUCCESS signals that scan completed. Other error conditions signify failure scan channel specified. This frame response callback command. Response parameters: int8u channel EmberStatus status channel which current error occurred. Undefined case EMBER_SUCCESS. error condition that occurred current channel. Value will EMBER_SUCCESS when scan completed.
Table
stopScan
0x1D
Name: stopScan
Description: Terminates scan progress. Command parameters: None Response parameters: EmberStatus status EmberStatus value indicating success reason failure.
Table
formNetwork
0x1E
Name: formNetwork
Description: Forms network becoming coordinator. Command parameters: EmberNetworkParameters Response parameters: EmberStatus status EmberStatus value indicating success reason failure. Specification network.
60/88
SN260 Table joinNetwork
0x1F
EmberZNet serial protocol
Name: joinNetwork
Description: Causes stack associate with network using specified network parameters. take several seconds stack associate with local network. send messages until stackStatusHandler callback informs that stack Command parameters: EmberNodeType nodeType EmberNetworkParameters Specification role that this node will have network. This role must EMBER_COORDINATOR. coordinator, formNetwork command. Specification network with which node should associate. true, node uses current secure messages during joining process. proper value secured networks depends upon their configuration. Some networks unsecured joining distribute from coordinator. Other networks require secure joining accept only nodes that know correct key. This value effect security level
boolean joinSecurely
Response parameters: EmberStatus status EmberStatus value indicating success reason failure.
Table
scanAndFormNetwork
0x4F
Name: scanAndFormNetwork
Description: Scan available channel then form network. This performs following actions: Performs energy scan indicated channels randomly chooses from amongst those with least average energy. Randomly picks that does appear during active scan chosen channel. Forms network using chosen channel errors occur status code passed scanErrorHandler callback network formed. Success indicated when stackStatusHandler callback invoked with EMBER_NETWORK_UP status value. Command parameters: Bits indicate that this particular channel should scanned. Bits indicate that this particular channel should scanned. example, channelMask value 0x00000001 would indicate that only channel should scanned. Valid channels range from inclusive. This translates channel mask value 0x07FFF800. power setting, dBm.
int32u channelMask
int8s radioTxPower Response parameters: None
Table
scanAndJoinNetwork
0x50
Name: scanAndJoinNetwork
Description: Scan join network. This performs following actions: Does active scan find network that uses stack profile currently allows nodes join. Joins chosen network. errors occur status code passed scanErrorHandler callback network joined. Success indicated when stackStatusHandler callback invoked with EMBER_NETWORK_UP status value.
61/88
EmberZNet serial protocol Table scanAndJoinNetwork (continued)
SN260
Command parameters: EmberNodeType nodeType Specification role that this node will have network. This role must EMBER_COORDINATOR. coordinator, scanAndformNetwork command. Bits indicate that this particular channel should scanned. Bits indicate that this particular channel should scanned. example, channelMask value 0x00000001 would indicate that only channel should scanned. Valid channels range from inclusive. This translates channel mask value 0x07FFF800. power setting, dBm. true, node uses current secure messages during joining process. proper value secured networks depends upon their configuration. Some networks unsecured joining distribute from coordinator. Other networks require secure joining accept only nodes that know correct key. This value effect security level
int32u channelMask
int8s radioTxPower
boolean joinSecurely
Response parameters: None
Table
scanErrorHandler
0x51
Name: scanErrorHandler
Description: This callback invoked error occurs while attempting scanAndFormNetwork scanAndJoinNetwork. This frame response callback command. Response parameters: EmberStatus status EmberStatus value indicating reason scanAndFormNetwork scanAndJoinNetwork failure.
Table
leaveNetwork
0x20
Name: leaveNetwork
Description: Causes stack leave current network. This generates stackStatusHandler callback indicate that network down. radio will used until after sending formNetwork joinNetwork command. Command parameters: None Response parameters: EmberStatus status EmberStatus value indicating success reason failure.
Table
mobileNodeHasMoved
0x21
Name: mobileNodeHasMoved
Description: Informs stack that contact with network been lost. Only devices that joined network with node type EMBER_MOBILE_END_DEVICE call this function. This generates stackStatusHandler callback indicate that network down. stack will re-establish contact with network. second stackStatusHandler callback indicates either success failure attempt. Command parameters: None
62/88
SN260 Table mobileNodeHasMoved (continued)
EmberZNet serial protocol
Response parameters: EmberStatus status EmberStatus value indicating success reason failure.
Table
permitJoining
0x22
Name: permitJoining
Description: Tells stack allow other nodes join network with this node their parent. Joining initially disabled default. Command parameters: int8u duration Response parameters: EmberStatus status EmberStatus value indicating success reason failure. value 0x00 disables joining. value 0xFF enables joining. other value enables joining that number seconds.
Table
childJoinHandler
0x23
Name: childJoinHandler
Description: Indicates that child joined left. This frame response callback command. Response parameters: int8u index boolean joining EmberNodeId childId EmberEUI64 childEui64 EmberNodeType childType index child interest. True child joining. False child leaving. node child. EUI64 child. node type child.
Table
trustCenterJoinHandler
0x24
Name: trustCenterJoinHandler
Description: SN260 used trust center behavior policy decide whether allow node join network. Host cannot change current decision, change policy future decisions using setPolicy command. This frame response callback command. Response parameters: EmberEUI64 newNode boolean securedJoin EmberJoinDecision policyDecision EUI64 node that wished join. True node joining securely using network security key. EmberJoinDecision reflecting decision made.
63/88
EmberZNet serial protocol Table
SN260
Name: 0x25 Description: Initiates upload discovery information parent this node. Only devices that joined network with node type EMBER_SLEEPY_END_DEVICE call this function. parent stores information discovery cache. information sent using messages with cluster NODE_DESCRIPTOR_RESPONSE, POWER_DESCRIPTOR_RESPONSE SIMPLE_DESCRIPTOR_RESPONSE. Command parameters: None Response parameters: EmberStatus status EmberStatus value indicating success reason failure.
Table
getEui64
0x26
Name: getEui64
Description: Returns EUI64 local node. Command parameters: None Response parameters: EmberEUI64 eui64 64-bit
Table
getNodeId
0x27
Name: getNodeId
Description: Returns 16-bit node local node. Command parameters: None Response parameters: EmberNodeId nodeId 16-bit
Table
getNetworkParameters
0x28
Name: getNetworkParameters
Description: Returns current network parameters. Command parameters: None Response parameters: EmberStatus status EmberNodeType nodeType EmberNetworkParameters EmberStatus value indicating success reason failure. EmberNodeType value indicating current node type. current network parameters.
Table
getParentChildParameters
0x29
Name: getParentChildParameters
Description: Returns information about children local node parent local node. Command parameters: None
64/88
SN260 Table getParentChildParameters (continued)
EmberZNet serial protocol
Response parameters: int8u childCount EmberEUI64 parentEui64 EmberNodeId parentNodeId number children node currently has. parent's EUI64. value undefined nodes without parents (coordinators nodes that joined network). parent's node value undefined nodes without parents (coordinators nodes that joined network).
Table
getChildData
0x4A
Name: getChildData
Description: Returns information about child local node. Command parameters: int8u index Response parameters: EmberStatus status EmberNodeId childId EmberEUI64 childEui64 EmberNodeType childType EMBER_SUCCESS there child index. EMBER_NOT_JOINED there child index. node child. EUI64 child. EmberNodeType value child. index child interest child table. Possible indexes range from zero EMBER_CHILD_TABLE_SIZE.
7.3.7
Table
Binding frames
clearBindingTable
0x2A
Name: clearBindingTable
Description: Deletes binding table entries. Command parameters: None Response parameters: EmberStatus status EmberStatus value indicating success reason failure.
Table
setBinding
0x2B
Name: setBinding
Description: Sets entry binding table. Command parameters: int8u index EmberBindingTableEntry value Response parameters: EmberStatus status EmberStatus value indicating success reason failure. index binding table entry. contents binding entry.
65/88
EmberZNet serial protocol Table getBinding
0x2C
getBinding
SN260
Name: getBinding
Description: Gets entry from binding table. Command parameters: int8u index Response parameters: EmberStatus status EmberBindingTableEntry value EmberStatus value indicating success reason failure. contents binding entry. index binding table entry.
Table
deleteBinding
0x2D
Name: deleteBinding
Description: Deletes binding table entry. Command parameters: int8u index Response parameters: EmberStatus status EmberStatus value indicating success reason failure. index binding table entry.
Table
bindingIsActive
0x2E
Name: bindingIsActive
Description: Indicates whether binding table entry active-that whether connection open messages route from Note that this command does indicate whether binding clear. determine whether binding clear, check whether type field EmberBindingTableEntry value EMBER_UNUSED_BINDING. Command parameters: int8u index Response parameters: boolean active True binding table entry active. False binding table entry active. index binding table entry.
Table
getBindingDestinationNodeId
0x2F
Name: getBindingDestinationNodeId
Description: Returns node binding's destination, known. message sent using binding destination's known, stack will discover broadcasting address request. application avoid need this discovery using setBindingDestinationNodeId when knows correct some other means. destination's node forgotten when binding changed, when local node reboots much more rarely, when destination node changes response conflict. Command parameters: int8u index index binding table entry.
66/88
SN260 Table getBindingDestinationNodeId (continued)
EmberZNet serial protocol
Response parameters: EmberNodeId nodeId short destination node EMBER_NULL_NODE_ID destination known.
Table
setBindingDestinationNodeId
0x30
Name: setBindingDestinationNodeId
Description: node binding's destination. getBindingDestinationNodeId description. Command parameters: int8u index EmberNodeId nodeId Response parameters: None index binding table entry. short destination node.
Table
remoteSetBindingHandler
0x31
Name: remoteSetBindingHandler
Description: SN260 used external binding modification policy decide handle remote binding request. Host cannot change current decision, change policy future decisions using setPolicy command. This frame response callback command. Response parameters: EmberBindingTableEntry entry int8u index EmberStatus policyDecision requested binding. index which binding added. EMBER_SUCCESS binding added table other status not.
Table
remoteDeleteBindingHandler
0x32
Name: remoteDeleteBindingHandler
Description: SN260 used external binding modification policy decide handle remote delete binding request. Host cannot change current decision, change policy future decisions using setPolicy command. This frame response callback command. Response parame
Other recent searches
NE851M13 - NE851M13 NE851M13 Datasheet
MPC2605FACT - MPC2605FACT MPC2605FACT Datasheet
IL33091A - IL33091A IL33091A Datasheet
IL33091AN - IL33091AN IL33091AN Datasheet
IL33091AD - IL33091AD IL33091AD Datasheet
EN29LV800A - EN29LV800A EN29LV800A Datasheet
DCR0015A - DCR0015A DCR0015A Datasheet
AN-EVALSF3R-ICE3BR0665J - AN-EVALSF3R-ICE3BR0665J AN-EVALSF3R-ICE3BR0665J Datasheet
AEN-0106 - AEN-0106 AEN-0106 Datasheet
Privacy Policy | Disclaimer
© 2012 Datasheet Archive
