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@29:6711180763b6, 2014-06-05 (annotated)

Committer:
gert_lauritsen
Date:
Thu Jun 05 17:10:37 2014 +0000
Revision:
29:6711180763b6
Parent:
28:c724a8921f01
Child:
30:f9cdb6f62586
?ndret til rawseriel

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