Xbee changes 2
Fork of XBeeLib by
Diff: XBee802/XBee802.h
- Revision:
- 0:fcaad0dfa051
- Child:
- 1:794d1d3e4a08
diff -r 000000000000 -r fcaad0dfa051 XBee802/XBee802.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/XBee802/XBee802.h Fri May 08 11:50:56 2015 +0200 @@ -0,0 +1,357 @@ +/** + * Copyright (c) 2015 Digi International Inc., + * All rights not expressly granted are reserved. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. + * + * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343 + * ======================================================================= + */ + +#if !defined(__XBEE_802_H_) +#define __XBEE_802_H_ + +#include "FrameHandlers/FH_AtCmdResp.h" +#include "FrameHandlers/FH_RxPacket802.h" +#include "FrameHandlers/FH_IoDataSample802.h" +#include "RemoteXBee/RemoteXBee.h" + +namespace XBeeLib { + +/** Class for XBee ZigBee modules, derived from XBee */ +class XBee802 : public XBee +{ + public: + + /** + * IoLine for XBee802 Modules + */ + enum IoLine { + DIO0_AD0 = 0, /**< DIO0_AD0 pin */ + DIO1_AD1 = 1, /**< DIO1_AD1 pin */ + DIO2_AD2 = 2, /**< DIO2_AD2 pin */ + DIO3_AD3 = 3, /**< DIO3_AD3 pin */ + DIO4_AD4 = 4, /**< DIO4_AD4 pin */ + DIO5_AD5 = 5, /**< DIO5_AD5 pin */ + DIO6 = 6, /**< DIO6 pin */ + DIO7 = 7, /**< DIO7 pin */ + DI8 = 8, /**< DI8 pin */ + PWM0, /**< PWM0 pin */ + PWM1 /**< PWM1 pin */ + }; + + /** 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 + * @param reset the pin to which the XBee's reset line is attached to, use NC if not available + * @param rts the RTS pin for the UART that will interface the XBee module, use NC if not available + * @param cts the CTS pin for the UART that will interface the XBee module, use NC if not available + * @param baud the baudrate for the UART that will interface the XBee module. Note that the module has to be already configured + * to this baud rate (ATBD parameter). By default it is configured to 9600 bps + */ + XBee802(PinName tx, PinName rx, PinName reset = NC, PinName rts = NC, PinName cts = NC, int baud = 9600); + + /** Class destructor */ + virtual ~XBee802(); + + /** init - initializes object + * This function must be called just after creating the object so it initializes internal data. + * @returns + * Success if the module has been properly initialized and is ready to process data. + * Failure otherwise. + */ + RadioStatus init(); + + /** set_panid - sets the 16 bit PAN ID. + * + * @param panid the PAN ID value that will be set on the radio + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_panid(uint16_t panid); + + /** get_panid - gets the configured 16 bit PAN ID + * + * @param panid pointer where the read PAN ID value will be stored + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus get_panid(uint16_t * const panid); + + /** set_channel - sets the network channel number + * + * @param channel the channel in which the radio operates. Range is 0x0B - 0x1A for XBee and 0x0C - 0x17 for XBee-PRO. + * The Center Frequency = 2.405 + (CH - 11) * 5 MHz + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_channel(uint8_t channel); + + /** get_panid - gets the network channel number + * + * @param channel pointer where the channel value will be stored. + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus get_channel(uint8_t * const channel); + + /** set_network_address - sets the 16 bit network address of the device + * + * @param addr the device 16bit network address (0x0 - 0xFFFF) + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_network_address(uint16_t addr); + + /** register_node_discovery_cb - registers the callback function that will be called + * when the responses to the node discovery command arrive + * + * @param function function pointer with the callback function + */ + void register_node_discovery_cb(node_discovery_802_cb_t function); + + /** unregister_node_discovery_cb - removes the node discovery callback */ + void unregister_node_discovery_cb(); + + /** register_receive_cb - registers the callback function that will be called + * when a rx packet is received + * + * @param function function pointer with the callback function + */ + void register_receive_cb(receive_802_cb_t function); + + /** unregister_receive_cb - removes the rx packet callback */ + void unregister_receive_cb(); + + /** register_io_sample_cb - registers the callback function that will be called + * when a IO Sample Data packet is received + * + * @param function function pointer with the callback function + */ + void register_io_sample_cb(io_data_cb_802_t function); + + /** unregister_io_sample_cb - removes the IO Sample Data reception callback */ + void unregister_io_sample_cb(); + + /*********************** send_data member methods ************************/ + /** send_data - sends data to a remote device waiting for the packet + * answer with the result of the operation + * + * @param remote remote device + * @param data pointer to the data that will be sent + * @param len number of bytes that will be transmitted + * @returns the result of the data transfer + * TxStatusSuccess if the operation was successful, + * the error code otherwise + */ + virtual TxStatus send_data(const RemoteXBee& remote, const uint8_t *const data, uint16_t len); + + /** 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 + * @returns a RemoteXBee802 with the 16-bit and 64-bit address of the remote device whose node id matches with the parameter. + * If node is not found, the returned object will have invalid addresses (RemoteXBee802::is_valid() will return false). + */ + RemoteXBee802 get_remote_node_by_id(const char * const node_id); + + /* Allow using XBee::set_param() methods for local radio from this class */ + using XBee::set_param; + + /** set_param - sets a parameter in a remote radio by sending an AT command and waiting for the response. + * + * @param remote remote device + * @param param parameter to be set. + * @param data the parameter value (4 bytes) to be set. + * @returns the command response status. + */ + virtual AtCmdFrame::AtCmdResp set_param(const RemoteXBee& remote, const char * const param, uint32_t data); + + /** set_param - sets a parameter in a remote radio by sending an AT command and waiting for the response. + * + * @param remote remote device + * @param param parameter to be set. + * @param the parameter value byte array (len bytes) to be set. + * @param len number of bytes of the parameter value. + * @returns the command response status. + */ + virtual AtCmdFrame::AtCmdResp set_param(const RemoteXBee& remote, const char * const param, const uint8_t * data = NULL, uint16_t len = 0); + + /* Allow using XBee::get_param() methods for local radio from this class */ + using XBee::get_param; + + /** get_param - gets a parameter from a remote radio by sending an AT command and waiting for the response. + * + * @param remote remote device + * @param param parameter to be get. + * @param data pointer where the param value (4 bytes) will be stored. + * @returns the command response status. + */ + virtual AtCmdFrame::AtCmdResp get_param(const RemoteXBee& remote, const char * const param, uint32_t * const data); + + /** get_param - gets a parameter from a remote radio by sending an AT command and waiting for the response. + * + * @param remote remote device + * @param param parameter to be get. + * @param data pointer where the param value (n bytes) will be stored. + * @param len pointer where the number of bytes of the param value will be stored. + * @returns the command response status. + */ + virtual AtCmdFrame::AtCmdResp get_param(const RemoteXBee& remote, const char * const param, uint8_t * const data, uint16_t * const len); + + /************************* IO member methods **************************/ + /** set_pin_config - configures a radio IO line + * + * @param remote remote device + * @param line IO line being configured + * @param mode configuration mode for the selected line + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_pin_config(const RemoteXBee& remote, IoLine line, IoMode mode); + + /** get_pin_config - gets the configuration of a radio IO line + * + * @param remote remote device + * @param line IO line being read to get its configuration + * @param mode pointer where the configuration will be stored + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus get_pin_config(const RemoteXBee& remote, IoLine line, IoMode * const mode); + + /** set_dio - sets to low/high a DIO line + * + * @param remote remote device + * @param line DIO line being set + * @param val value that will be set in the DIO line + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_dio(const RemoteXBee& remote, IoLine line, DioVal val); + + /** get_dio - read the value of a DIO configured as digital input + * + * @param remote remote device + * @param line DIO line being read + * @param val pointer where the DIO value read will be stored + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus get_dio(const RemoteXBee& remote, IoLine line, DioVal * const val); + + /** get_adc - read the value of the espcified ADC line + * + * @param remote remote device + * @param line ADC line being read + * @param val pointer where the value read from the ADC will be stored + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus get_adc(const RemoteXBee& remote, IoLine line, uint16_t * const val); + + /** set_pwm - sets the duty cycle of a PWM line + * + * @param remote remote device + * @param line PWM line being set + * @param duty_cycle duty cycle that will be set in the PWM line + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_pwm(const RemoteXBee& remote, IoLine line, float duty_cycle); + + /** set_pin_pull_up - enables or disables the internal pull-up resistor of a line + * + * @param remote remote device + * @param line line being configured for pull-up + * @param enable whether to enable the internal pull-up resistor. + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus set_pin_pull_up(const RemoteXBee& remote, IoLine line, bool enable); + + /** enable_dio_change_detection - enables or disables the notification when a change is detected in a digital input line. + * In other words, it will force an IO Sample transmission when the DIO state changes. Only for DIO0 to DIO7. + * + * @param remote remote device + * @param line line being configured for pull-up + * @param enable whether to enable the internal pull-up resistor. + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus enable_dio_change_detection(const RemoteXBee& remote, IoLine line, bool enable); + +/* TODO: With current firmware ATM0 fails: Returns just OK and sets pwm to 0 */ +#ifdef GET_PWM_AVAILABLE + /** get_pwm - gets the duty cycle of a PWM line + * + * @param remote remote device + * @param line PWM line being read + * @param duty_cycle pointer where the value of the duty cycle read from + * the PWM line will be stored + * @returns + * Success if the operation was successful, + * Failure otherwise + */ + RadioStatus get_pwm(const RemoteXBee& remote, IoLine line, float * const duty_cycle); +#endif + + protected: + inline bool is_PRO() + { + return (_hw_version & 0xFF00U) == 0x1800U; + } + + /** Synchronization lost counter, automatically updated by the library */ + volatile uint16_t _sync_lost_cnt; + + /** Frame handler used for the node discovery. Registered when a callback function + * is registered */ + FH_NodeDiscovery802 *_nd_handler; + + /** Frame handler used for the rx 64 bit packets. Automatically registered when a callback + * function is registered */ + FH_RxPacket64b802 *_rx_64b_handler; + + /** Frame handler used for the rx 16 bit packets. Automatically registered when a callback + * function is registered */ + FH_RxPacket16b802 *_rx_16b_handler; + + /** Frame handler used for the 64 bit IO Data Samples packets. Automatically registered when a callback + * function is registered */ + FH_IoDataSampe64b802 *_io_data_64b_handler; + + /** Frame handler used for the 16 bit IO Data Samples packets. Automatically registered when a callback + * function is registered */ + FH_IoDataSampe16b802 *_io_data_16b_handler; + + /** Method called directly by the library when a modem status frame is received to + * update the internal status variables */ + virtual void radio_status_update(AtCmdFrame::ModemStatus modem_status); + + /* Allow using XBee::send_data() methods from this class */ + using XBee::send_data; + + private: + +}; + +} /* namespace XBeeLib */ + +#endif /* __XBEE_802_H_ */ + +