Gert Lauritsen / telegesis_lib

A libery to connect to telegesis zigbee module. Bassed on implemtation of XBEE

Fork of xbee_lib by Tristan Hughes

telegesis.h@24:5ed5311266b0, 2013-11-12 (annotated)

Committer:
gert_lauritsen
Date:
Tue Nov 12 09:19:52 2013 +0000
Revision:
24:5ed5311266b0
Parent:
23:8a7329b46e95
Child:
26:2a85af491d92
latest update

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gert_lauritsen 11:18ff088287ea 1 #ifndef telegesis_h
gert_lauritsen 11:18ff088287ea 2 #define telegesis_h
gert_lauritsen 11:18ff088287ea 3
tristanjph 0:2656fb225c5d 4 #include "mbed.h"
tristanjph 0:2656fb225c5d 5
gert_lauritsen 13:1b557befdeff 6 /**Eksemple
gert_lauritsen 13:1b557befdeff 7 #include "telegesis.h"
gert_lauritsen 13:1b557befdeff 8 zigbee ZB(p9,p10);
gert_lauritsen 13:1b557befdeff 9
gert_lauritsen 13:1b557befdeff 10 int main() {
gert_lauritsen 13:1b557befdeff 11 ZB.Reset();
gert_lauritsen 13:1b557befdeff 12 wait(1);
gert_lauritsen 13:1b557befdeff 13 ZB.GetSerial();
gert_lauritsen 13:1b557befdeff 14 while(1) {
gert_lauritsen 13:1b557befdeff 15 ZB.GetSerial();
gert_lauritsen 13:1b557befdeff 16 ZB.RecieveData(read_data,0);
gert_lauritsen 13:1b557befdeff 17 ZB.UniCast("0000","tester forbindelse");
gert_lauritsen 13:1b557befdeff 18 if (ZB.Zdat) {
gert_lauritsen 13:1b557befdeff 19 ZB.Zdat=0;
gert_lauritsen 13:1b557befdeff 20 printf(ZB.Zdata);
gert_lauritsen 13:1b557befdeff 21 }
gert_lauritsen 13:1b557befdeff 22 }
gert_lauritsen 13:1b557befdeff 23 }
gert_lauritsen 13:1b557befdeff 24
gert_lauritsen 13:1b557befdeff 25 */
gert_lauritsen 7:45511c3d2950 26 /** Zigbee interface class for configuring, sending and recieving data using an telegesis zigbee */
gert_lauritsen 11:18ff088287ea 27 #define START_BYTE 0x7e
gert_lauritsen 11:18ff088287ea 28 #define ESCAPE 0x7d
gert_lauritsen 11:18ff088287ea 29 #define MAX_FRAME_DATA_SIZE 110
gert_lauritsen 11:18ff088287ea 30
gert_lauritsen 7:45511c3d2950 31 class zigbee
tristanjph 2:cb627ea9b817 32 {
tristanjph 0:2656fb225c5d 33 private:
tristanjph 0:2656fb225c5d 34 PinName _tx;
tristanjph 0:2656fb225c5d 35 PinName _rx;
tristanjph 3:682615a0717e 36 PinName _reset;
gert_lauritsen 23:8a7329b46e95 37
tristanjph 0:2656fb225c5d 38 public:
gert_lauritsen 7:45511c3d2950 39
gert_lauritsen 11:18ff088287ea 40 zigbee(PinName tx, PinName rx);
gert_lauritsen 7:45511c3d2950 41 ~zigbee();
gert_lauritsen 7:45511c3d2950 42
gert_lauritsen 7:45511c3d2950 43
gert_lauritsen 7:45511c3d2950 44 /** Gets the serial number/mac address of the zigbee and places it into serial_no.
gert_lauritsen 7:45511c3d2950 45 * @param serial_no array to store the serial of zigbee (must be 8 long).
tristanjph 2:cb627ea9b817 46 * @return Returns 1 on success.
tristanjph 2:cb627ea9b817 47 */
gert_lauritsen 11:18ff088287ea 48 int GetSerial();
tristanjph 6:6455a079bdb3 49 /** Sets the encryption key. This should be a 128-bit key.
tristanjph 2:cb627ea9b817 50 * @param key Pointer to the network key to set.
tristanjph 2:cb627ea9b817 51 * @return Returns 1 on success.
tristanjph 1:c3d9bdcb0b03 52 */
tristanjph 5:714651141a83 53 int SetKey(char*);
gert_lauritsen 7:45511c3d2950 54
tristanjph 2:cb627ea9b817 55 /** Recieves data sent to the xbee.
tristanjph 2:cb627ea9b817 56 * @param data_buf Pointer to the buffer to put recieved data into.
tristanjph 2:cb627ea9b817 57 * @param numchar Number of characters to read. If 0, will use the size of data_buf.
tristanjph 2:cb627ea9b817 58 */
tristanjph 2:cb627ea9b817 59 void RecieveData(char*, int);
gert_lauritsen 10:263f7251c111 60 /** Get hw version and local ID (64bit uniq number)
gert_lauritsen 10:263f7251c111 61 *
gert_lauritsen 10:263f7251c111 62 */
gert_lauritsen 7:45511c3d2950 63 int ATI();
gert_lauritsen 10:263f7251c111 64 /** Sends a ping to Coo or any other adresse
gert_lauritsen 8:4682155753ec 65 *
gert_lauritsen 7:45511c3d2950 66 */
gert_lauritsen 7:45511c3d2950 67 int PingOut();
gert_lauritsen 10:263f7251c111 68 /** Scan the Pan for nodes
gert_lauritsen 7:45511c3d2950 69 */
gert_lauritsen 7:45511c3d2950 70 int PanScan();
gert_lauritsen 10:263f7251c111 71 /** Make a new network. It then gets the role as coordinator
gert_lauritsen 7:45511c3d2950 72 */
gert_lauritsen 7:45511c3d2950 73 int Establish_Network();
gert_lauritsen 10:263f7251c111 74 /** Join a pan
gert_lauritsen 7:45511c3d2950 75 */
gert_lauritsen 7:45511c3d2950 76 int JoinNetwork();
gert_lauritsen 20:070dc2050052 77 /** Leave a Pan
gert_lauritsen 20:070dc2050052 78 */
gert_lauritsen 20:070dc2050052 79 int LeaveNetwork();
gert_lauritsen 10:263f7251c111 80 /**
gert_lauritsen 10:263f7251c111 81 * Scan network
gert_lauritsen 7:45511c3d2950 82 */
gert_lauritsen 7:45511c3d2950 83 int ScanNetwork();
gert_lauritsen 10:263f7251c111 84 /**
gert_lauritsen 10:263f7251c111 85 *Give info on what role the modem has in the network
gert_lauritsen 7:45511c3d2950 86 */
gert_lauritsen 10:263f7251c111 87
gert_lauritsen 7:45511c3d2950 88 int NetworkInfo();
gert_lauritsen 10:263f7251c111 89 /**
gert_lauritsen 7:45511c3d2950 90 */
gert_lauritsen 12:debf76f0c0bf 91 int Reset();
gert_lauritsen 8:4682155753ec 92 /** Sends data using the ascii mode
gert_lauritsen 10:263f7251c111 93 */
gert_lauritsen 9:c8e4339ccc29 94 int UniCast(char *adr,char *payload);
gert_lauritsen 8:4682155753ec 95 /** Sends data using the binary mode
gert_lauritsen 8:4682155753ec 96 */
gert_lauritsen 9:c8e4339ccc29 97 int UniCastb(char *adr,char *payload, char payloadSize);
gert_lauritsen 11:18ff088287ea 98
gert_lauritsen 10:263f7251c111 99
gert_lauritsen 9:c8e4339ccc29 100 /** converts a string to a long
gert_lauritsen 9:c8e4339ccc29 101 */
gert_lauritsen 11:18ff088287ea 102 unsigned long hextolong(const char *hex);
gert_lauritsen 8:4682155753ec 103 /** convertes a string to a int
gert_lauritsen 8:4682155753ec 104 */
gert_lauritsen 11:18ff088287ea 105 unsigned int hextoint(const char *hex);
gert_lauritsen 9:c8e4339ccc29 106 /**
gert_lauritsen 9:c8e4339ccc29 107 */
gert_lauritsen 7:45511c3d2950 108 int EUI64;
gert_lauritsen 9:c8e4339ccc29 109 /** COO or FBB
gert_lauritsen 9:c8e4339ccc29 110 */
gert_lauritsen 20:070dc2050052 111 char Devicetype[4];
gert_lauritsen 9:c8e4339ccc29 112 /** Gives type of HW
gert_lauritsen 9:c8e4339ccc29 113 */
gert_lauritsen 9:c8e4339ccc29 114 char HWType[15];
gert_lauritsen 9:c8e4339ccc29 115 /** incomming data
gert_lauritsen 9:c8e4339ccc29 116 */
gert_lauritsen 18:10fcddf238c9 117 char Zdata[80];
gert_lauritsen 11:18ff088287ea 118 /**
gert_lauritsen 11:18ff088287ea 119
gert_lauritsen 11:18ff088287ea 120 */
gert_lauritsen 18:10fcddf238c9 121 char LocalID[17];
gert_lauritsen 11:18ff088287ea 122 /**
gert_lauritsen 11:18ff088287ea 123 * indication of incoming data
gert_lauritsen 11:18ff088287ea 124 */
gert_lauritsen 11:18ff088287ea 125 uint8_t Zdat;
gert_lauritsen 11:18ff088287ea 126 /**
gert_lauritsen 11:18ff088287ea 127 * Indicator on that we have got a ack on a packet
gert_lauritsen 11:18ff088287ea 128 */
gert_lauritsen 11:18ff088287ea 129 uint8_t PacketAck;
gert_lauritsen 11:18ff088287ea 130
gert_lauritsen 11:18ff088287ea 131 int channel, NodeID, EPID,framesize, PanOnline;
gert_lauritsen 21:9c5b72a64495 132 char NetNodeID[17]; //a remote node
gert_lauritsen 21:9c5b72a64495 133 char NetInfo; //indication that network info is ready
gert_lauritsen 17:5a3f81b10a61 134 /**
gert_lauritsen 17:5a3f81b10a61 135 */
gert_lauritsen 17:5a3f81b10a61 136 uint8_t ErrorCode;
gert_lauritsen 11:18ff088287ea 137 /**
gert_lauritsen 11:18ff088287ea 138 * Reads all available serial bytes until a packet is parsed, an error occurs, or the buffer is empty.
gert_lauritsen 11:18ff088287ea 139 * You may call <i>xbee</i>.getResponse().isAvailable() after calling this method to determine if
gert_lauritsen 11:18ff088287ea 140 * a packet is ready, or <i>xbee</i>.getResponse().isError() to determine if
gert_lauritsen 11:18ff088287ea 141 * a error occurred.
gert_lauritsen 11:18ff088287ea 142 * <p/>
gert_lauritsen 11:18ff088287ea 143 * This method should always return quickly since it does not wait for serial data to arrive.
gert_lauritsen 11:18ff088287ea 144 * You will want to use this method if you are doing other timely stuff in your loop, where
gert_lauritsen 11:18ff088287ea 145 * a delay would cause problems.
gert_lauritsen 11:18ff088287ea 146 * NOTE: calling this method resets the current response, so make sure you first consume the
gert_lauritsen 11:18ff088287ea 147 * current response
gert_lauritsen 11:18ff088287ea 148 */
gert_lauritsen 11:18ff088287ea 149 void readPacket();
gert_lauritsen 11:18ff088287ea 150 /**Looks for a packet but dont wait
gert_lauritsen 11:18ff088287ea 151 */
gert_lauritsen 12:debf76f0c0bf 152 void SeePacket();
gert_lauritsen 18:10fcddf238c9 153 /**
gert_lauritsen 18:10fcddf238c9 154 * Non blocking check og data. To be used in NON IRQ mode
gert_lauritsen 18:10fcddf238c9 155 */
gert_lauritsen 18:10fcddf238c9 156 void Work();
gert_lauritsen 19:78f44233a12f 157 char _responseFrameString[MAX_FRAME_DATA_SIZE];
gert_lauritsen 24:5ed5311266b0 158 uint8_t GotFrame; //indicate that a frame has been recieved
gert_lauritsen 11:18ff088287ea 159 private:
gert_lauritsen 11:18ff088287ea 160 uint8_t b;
gert_lauritsen 11:18ff088287ea 161 int SeqNumber;
gert_lauritsen 24:5ed5311266b0 162
gert_lauritsen 11:18ff088287ea 163 // buffer for incoming RX packets. holds only the api specific frame data, starting after the api id byte and prior to checksum
gert_lauritsen 19:78f44233a12f 164
gert_lauritsen 18:10fcddf238c9 165 Serial _zbee;
gert_lauritsen 12:debf76f0c0bf 166 bool wait4OK();
gert_lauritsen 20:070dc2050052 167 bool wait4Offline();
gert_lauritsen 20:070dc2050052 168 bool wait4JPAN();
gert_lauritsen 20:070dc2050052 169 bool wait4str(char *p);
gert_lauritsen 11:18ff088287ea 170 };
gert_lauritsen 11:18ff088287ea 171
gert_lauritsen 11:18ff088287ea 172 #endif