5. APIs and Events

APIs

• init()
• close()
• request()
• sendCmd()

Events

• 'ready'
• 'close'
• 'data'
• 'AREQ'

---

.init(spCfg, callback)

Enable a serial port connecting to CC253X SoC with given spCfg.path.

Arguments:

1. spCfg (Object): Configuration of the seiralport instance. Accepted properties of spCfg are listed in the following table.

   Property	Type	Description
   path	String	System path of the serial port to open. e.g., /dev/ttyUSB0.
   options	Object	Port configuration options.

2. callback (Function): function (err) { ... }

Returns:

• none

Examples:

var znp = require('cc-znp');
var spCfg = {
    path: '/dev/ttyUSB0',
    options: {
        baudrate: 115200,
        rtscts: true
    }
};

znp.init(spCfg, function (err) {
    if (err)
        console.log(err);
});

---

.close([callback])

This method will close the opened serial port.

Arguments:

1. callback (Function): function (err) { ... }

Returns:

• none

Examples:

znp.close(function (err) {
    if (err)
        console.log(err);
});

---

.request(subsys, cmdId, valObj, callback)

Invoke TI Z-Stack Monitor and Test Commands.

Arguments:

1. subsys (Number | String): Subsystem, i.e., set it to 1 or 'SYS' to invoke a SYS command.

2. cmdId (Number | String): Command id of which subsys command you like to invoke. See Z-Stack MT API Reference Tables Section.

3. valObj (Object): An argument object of the command.

4. callback (Function): function (err, result) { ... }. Get called when the 'SRSP' is received.

• Subsystem

  {
      "SYS": 1,
      "MAC": 2,
      "NWK": 3,
      "AF": 4,
      "ZDO": 5,
      "SAPI": 6,
      "UTIL": 7,
      "DBG": 8,
      "APP": 9
  }

Returns:

• none

Examples:

// example of calling ping() from the subsystem 'SYS'
znp.request('SYS', 'ping', {}, function (err, result) {
    if (err) 
        console.log(err);
    else 
        console.log(result);    // { capabilities: 121 }
});

// use numbered ids. The first 1 is subsystem 'SYS', and the second 1 is command 'ping'
znp.request(1, 1, {}, function (err, result) {
    if (err) 
        console.log(err);
    else 
        console.log(result);    // { capabilities: 121 }
});

Request Shorthands:

1. .sysRequest(cmdId, valObj, callback)
2. .macRequest(cmdId, valObj, callback)
3. .nwkRequest(cmdId, valObj, callback)
4. .afRequest(cmdId, valObj, callback)
5. .zdoRequest(cmdId, valObj, callback)
6. .sapiRequest(cmdId, valObj, callback)
7. .utilRequest(cmdId, valObj, callback)
8. .dbgRequest(cmdId, valObj, callback)
9. .appRequest(cmdId, valObj, callback)

Examples:

// examples with shorthands

znp.sysRequest('ping', {}, function (err, result) {
    console.log(result);    // { capabilities: 121 }
});

znp.utilRequest('setPanid', { panid: 0xFFFF }, function (err, result) {
    console.log(result);    // { status: 0 }
});

---

.sendCmd(type, subsys, cmdId, payload)

Exports the dependencies Unpi send() API, you can take it to send some binary data.

Arguments:

1. type (Number | String): The command type. For exmaple, set type to 1 or 'SREQ' to send a synchronous command.

2. subsys (Number | String): The subsystem. For example, send a command of subsystem 'RPC_SYS_UTIL', you can set subsys to 7, 'RPC_SYS_UTIL', or simply 'UTIL' (the prefix 'RPC_SYS_' can be ignored).

3. cmdId (Number): The command id which is a number according to which subsystem you are using.

4. payload (Buffer): The data payload.

Returns:

• (Buffer): Buffer of the built command packet.

Examples:

// The following calls do the same thing
znp.send('AREQ', 'SYS', 0, new Buffer([ 0 ]));
znp.send('AREQ', 1, 0, new Buffer([ 0 ]));
znp.send(2, 'SYS', 0, new Buffer([ 0 ]));
znp.send(2, 1, 0, new Buffer([ 0 ]));

---

.on('ready', function () { ... })

'ready' event will be fired when the initializing procedure accomplishes.

Examples:

znp.on('ready', function () {
    console.log('Initialization completes.');
});

---

.on('close', function () { ... })

Fired when the serial port is closed.

Examples:

znp.on('close', function () {
    console.log('The serialport is closed.');
});

---

.on('data', function (data) { ... })

The 'data' event will be fired along with the parsed result. Here is an example of the parsed data to show you the format. The csum is the checksum calculated from the received binaries. You can use it to check that if the received packet is corrupted.

{ 
    sof: 254,
    len: 6,
    type: 2,
    subsys: 1,
    cmd: 128,
    payload: <Buffer 02 02 00 02 06 02>,
    fcs: 193,  // this is the checksum originated from the sender
    csum: 193  // this is the checksum calculated from the received binaries
}

Examples:

znp.on('data', function (data) {
    console.log(data);  // The parsed data
});

---

.on('AREQ', function (msg) { ... })

When there is an 'AREQ' message coming from ZNP, an 'AREQ' event will be fired along with the message content. Here is an example of the msg format.

{
    subsys: 'ZDO',
    ind: 'endDeviceAnnceInd',
    data: { srcaddr: 63536, nwkaddr: 63536, ieeeaddr: '0x00124b0001ce3631', capabilities: 142 }
}

Examples:

znp.on('AREQ', function (msg) {
    console.log(msg);
});