Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of XBeeLib by
Diff: XBeeDM/XBeeDM.h
- Revision:
- 8:b5f4a0e92249
- Parent:
- 7:3ac2a461ce76
- Child:
- 9:780db84ce891
--- a/XBeeDM/XBeeDM.h Thu Jul 28 15:36:36 2016 +0200 +++ b/XBeeDM/XBeeDM.h Fri Jul 29 12:10:38 2016 +0200 @@ -45,25 +45,6 @@ DIO12 = 12 /**< DIO12 pin */ }; - enum AssocStatus { - ErrorReading = -1, /**< Error occurred when reading parameter. */ - Joined = 0x00, /**< Successfully formed or joined a network. (Coordinators form a network, routers and end devices join a network.) */ - NoPANs = 0x21, /**< Scan found no PANs */ - NoValidPAN = 0x22, /**< Scan found no valid PANs based on current SC and ID settings */ - JoinNotAllowed = 0x23, /**< Valid Coordinator or Routers found, but they are not allowing joining (NJ expired). */ - NoBeacons = 0x24, /**< No joinable beacons were found. */ - Unexpected = 0x25, /**< Unexpected state, node should not be attempting to join at this time. */ - JoinFailed = 0x27, /**< Node Joining attempt failed (typically due to incompatible security settings). */ - CoordStartFail = 0x2A, /**< Coordinator start attempt failed */ - CheckingCoord = 0x2B, /**< Checking for an existing coordinator. */ - LeaveFail = 0x2C, /**< Attempt to leave the network failed. */ - JoinNoResponse = 0xAB, /**< Attempted to join a device that did not respond. */ - SecKeyUnsec = 0xAC, /**< Secure join error - network security key received unsecured. */ - SecKeyNotRec = 0xAD, /**< Secure join error - network security key not received. */ - SecBadKey = 0xAF, /**< Secure join error - joining device does not have the right preconfigured link key. */ - Scanning = 0xFF /**< Scanning for a ZigBee network (routers and end devices). */ - }; - /** Class constructor * @param tx the TX pin of the UART that will interface the XBee module * @param rx the RX pin of the UART that will interface the XBee module @@ -123,7 +104,7 @@ */ RadioStatus get_network_id(uint16_t * const network_id); - /** set_network_security_key - (Coordinator only) Set the 128-bit AES network encryption key. If set to 0 (default), the module will select a random network key. + /** set_tc_link_key - Sets key used for encryption and decryption (ZigBee trust center link key). * It is not recommended to set the key programmatically, because it could be read through the raw serial port bits. * @param key pointer to the 128-bit AES key * @param length size of the buffer pointed by 'key' @@ -131,19 +112,7 @@ * Success if the operation was successful, * Failure otherwise */ - RadioStatus set_network_security_key(const uint8_t * const key, const uint16_t length); - -#define XBEE_DM_ENC_OPT_SEND_KEY_ON_JOIN 0x01 -#define XBEE_DM_ENC_OPT_USE_TRUST_CENTER 0x02 - /** set_encryption_options - Configure options for encryption. Unused option bits should be set to 0. Options include: - * - XBEE_DM_ENC_OPT_SEND_KEY_ON_JOIN - Send the security key unsecured over-the-air during joins - * - XBEE_DM_ENC_OPT_USE_TRUST_CENTER - Use trust center (coordinator only) - * @param options bit mask with the encryption options - * @returns - * Success if the operation was successful, - * Failure otherwise - */ - RadioStatus set_encryption_options(const uint8_t options); + RadioStatus set_tc_link_key(const uint8_t * const key, const uint16_t length); /** register_node_discovery_cb - registers the callback function that will be called * when the responses to the node discovery command arrive @@ -219,12 +188,6 @@ */ TxStatus send_data_to_coordinator(const uint8_t *const data, uint16_t len, bool syncr = true); - /** get_assoc_status - returns current network association status. This wraps AI parameter, for more information refer to moudle's Reference Manual. - * - * @returns an AssocStatus with current network association status. - */ - AssocStatus get_assoc_status(void); - /** get_remote_node_by_id - searches for a device in the network with the specified Node Identifier. * * @param node_id node id of the device we are looking for