Matthias Grob & Manuel Stalder / Mbed 2 deprecated DecaWave

This is the DW1000 driver and our self developed distance measurement application based on it. We do this as a semester thesis at ETH Zürich under the Automatic Control Laboratory in the Department of electrical engineering.

Dependencies:   mbed

DW1000/DW1000.cpp@36:883de6f9a73b, 2015-02-20 (annotated)

Committer:
manumaet
Date:
Fri Feb 20 09:07:52 2015 +0000
Revision:
36:883de6f9a73b
Parent:
31:6f76f3d518ac
Child:
37:40f94c634c3e
before changing data rate (disabled resetAll)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
manumaet 0:f50e671ffff7 1 #include "DW1000.h"
manumaet 0:f50e671ffff7 2
manumaet 20:257d56530ae1 3 DW1000::DW1000(PinName MOSI, PinName MISO, PinName SCLK, PinName CS, PinName IRQ) : irq(IRQ), spi(MOSI, MISO, SCLK), cs(CS) {
manumaet 26:a65c6f26c458 4 setCallbacks(NULL, NULL);
manumaet 17:8afa5f9122da 5
manumaet 0:f50e671ffff7 6 deselect(); // Chip must be deselected first
manumaet 0:f50e671ffff7 7 spi.format(8,0); // Setup the spi for standard 8 bit data and SPI-Mode 0 (GPIO5, GPIO6 open circuit or ground on DW1000)
manumaet 0:f50e671ffff7 8 spi.frequency(1000000); // with a 1MHz clock rate (worked up to 49MHz in our Test)
manumaet 7:e634eeafc4d2 9
manumaet 36:883de6f9a73b 10 //resetAll(); // we do a soft reset of the DW1000 everytime the driver starts
manumaet 12:985aa9843c3c 11 loadLDE(); // important everytime DW1000 initialises/awakes otherwise the LDE algorithm must be turned of or there's receiving malfunction see User Manual LDELOAD on p22 & p158
manumaet 18:bbc7ca7d3a95 12
manumaet 18:bbc7ca7d3a95 13 // Configuration TODO: make method for that
manumaet 12:985aa9843c3c 14 writeRegister8(DW1000_SYS_CFG, 3, 0x20); // enable auto reenabling receiver after error
manumaet 36:883de6f9a73b 15 //writeRegister8(DW1000_SYS_CFG, 2, 0x03); // enable 1024 byte frames TODO: is this really what stated in the comment?
manumaet 11:c87d37db2c6f 16
manumaet 8:7a9c61242e2f 17 irq.rise(this, &DW1000::ISR); // attach Interrupt handler to rising edge
manumaet 0:f50e671ffff7 18 }
manumaet 0:f50e671ffff7 19
manumaet 29:019ff388ed76 20 void DW1000::setCallbacks(void (*callbackRX)(void), void (*callbackTX)(void)) {
manumaet 29:019ff388ed76 21 bool RX = false;
manumaet 29:019ff388ed76 22 bool TX = false;
manumaet 29:019ff388ed76 23 if (callbackRX) {
manumaet 29:019ff388ed76 24 DW1000::callbackRX.attach(callbackRX);
manumaet 29:019ff388ed76 25 RX = true;
manumaet 29:019ff388ed76 26 }
manumaet 29:019ff388ed76 27 if (callbackTX) {
manumaet 29:019ff388ed76 28 DW1000::callbackTX.attach(callbackTX);
manumaet 29:019ff388ed76 29 TX = true;
manumaet 29:019ff388ed76 30 }
manumaet 29:019ff388ed76 31 setInterrupt(RX,TX);
manumaet 26:a65c6f26c458 32 }
manumaet 26:a65c6f26c458 33
manumaet 0:f50e671ffff7 34 uint32_t DW1000::getDeviceID() {
manumaet 0:f50e671ffff7 35 uint32_t result;
manumaet 0:f50e671ffff7 36 readRegister(DW1000_DEV_ID, 0, (uint8_t*)&result, 4);
manumaet 0:f50e671ffff7 37 return result;
manumaet 0:f50e671ffff7 38 }
manumaet 0:f50e671ffff7 39
manumaet 0:f50e671ffff7 40 uint64_t DW1000::getEUI() {
manumaet 0:f50e671ffff7 41 uint64_t result;
manumaet 0:f50e671ffff7 42 readRegister(DW1000_EUI, 0, (uint8_t*)&result, 8);
manumaet 0:f50e671ffff7 43 return result;
manumaet 0:f50e671ffff7 44 }
manumaet 0:f50e671ffff7 45
manumaet 0:f50e671ffff7 46 void DW1000::setEUI(uint64_t EUI) {
manumaet 0:f50e671ffff7 47 writeRegister(DW1000_EUI, 0, (uint8_t*)&EUI, 8);
manumaet 0:f50e671ffff7 48 }
manumaet 0:f50e671ffff7 49
manumaet 0:f50e671ffff7 50 float DW1000::getVoltage() {
manumaet 12:985aa9843c3c 51 uint8_t buffer[7] = {0x80, 0x0A, 0x0F, 0x01, 0x00}; // algorithm form User Manual p57
manumaet 0:f50e671ffff7 52 writeRegister(DW1000_RF_CONF, 0x11, buffer, 2);
manumaet 0:f50e671ffff7 53 writeRegister(DW1000_RF_CONF, 0x12, &buffer[2], 1);
manumaet 0:f50e671ffff7 54 writeRegister(DW1000_TX_CAL, 0x00, &buffer[3], 1);
manumaet 0:f50e671ffff7 55 writeRegister(DW1000_TX_CAL, 0x00, &buffer[4], 1);
manumaet 8:7a9c61242e2f 56 readRegister(DW1000_TX_CAL, 0x03, &buffer[5], 2); // get the 8-Bit readings for Voltage and Temperature
manumaet 0:f50e671ffff7 57 float Voltage = buffer[5] * 0.0057 + 2.3;
manumaet 20:257d56530ae1 58 //float Temperature = buffer[6] * 1.13 - 113.0; // TODO: getTemperature was always ~35 degree with better formula/calibration see instance_common.c row 391
manumaet 0:f50e671ffff7 59 return Voltage;
manumaet 0:f50e671ffff7 60 }
manumaet 0:f50e671ffff7 61
manumaet 18:bbc7ca7d3a95 62 uint64_t DW1000::getStatus() {
manumaet 18:bbc7ca7d3a95 63 return readRegister40(DW1000_SYS_STATUS, 0);
manumaet 18:bbc7ca7d3a95 64 }
manumaet 18:bbc7ca7d3a95 65
manumaet 26:a65c6f26c458 66 uint64_t DW1000::getRXTimestamp() {
manumaet 26:a65c6f26c458 67 return readRegister40(DW1000_RX_TIME, 0);
manumaet 26:a65c6f26c458 68 }
manumaet 26:a65c6f26c458 69
manumaet 26:a65c6f26c458 70 uint64_t DW1000::getTXTimestamp() {
manumaet 26:a65c6f26c458 71 return readRegister40(DW1000_TX_TIME, 0);
manumaet 26:a65c6f26c458 72 }
manumaet 26:a65c6f26c458 73
manumaet 10:d077bb12d259 74 void DW1000::sendString(char* message) {
manumaet 10:d077bb12d259 75 sendFrame((uint8_t*)message, strlen(message)+1);
manumaet 10:d077bb12d259 76 }
manumaet 10:d077bb12d259 77
manumaet 24:6f25ba679490 78 void DW1000::receiveString(char* message) {
manumaet 31:6f76f3d518ac 79 readRegister(DW1000_RX_BUFFER, 0, (uint8_t*)message, getFramelength()); // get data from buffer
manumaet 10:d077bb12d259 80 }
manumaet 10:d077bb12d259 81
manumaet 11:c87d37db2c6f 82 void DW1000::sendFrame(uint8_t* message, uint16_t length) {
manumaet 20:257d56530ae1 83 if (length >= 1021) length = 1021; // check for maximim length a frame can have TODO: 127 Byte mode?
manumaet 13:b4d27bf7062a 84 writeRegister(DW1000_TX_BUFFER, 0, message, length); // fill buffer
manumaet 7:e634eeafc4d2 85
manumaet 21:23bf4399020d 86 uint8_t backup = readRegister8(DW1000_TX_FCTRL, 1); // put length of frame
manumaet 21:23bf4399020d 87 length += 2; // including 2 CRC Bytes
manumaet 11:c87d37db2c6f 88 length = ((backup & 0xFC) << 8) | (length & 0x03FF);
manumaet 21:23bf4399020d 89 writeRegister16(DW1000_TX_FCTRL, 0, length);
manumaet 11:c87d37db2c6f 90
manumaet 25:d58b0595b300 91 stopTRX(); // stop receiving
manumaet 23:661a79e56208 92 writeRegister8(DW1000_SYS_CTRL, 0, 0x02); // trigger sending process by setting the TXSTRT bit
manumaet 25:d58b0595b300 93 startRX(); // enable receiver again
manumaet 8:7a9c61242e2f 94 }
manumaet 8:7a9c61242e2f 95
manumaet 17:8afa5f9122da 96 void DW1000::startRX() {
manumaet 20:257d56530ae1 97 writeRegister8(DW1000_SYS_CTRL, 0x01, 0x01); // start listening for preamble by setting the RXENAB bit
manumaet 7:e634eeafc4d2 98 }
manumaet 7:e634eeafc4d2 99
manumaet 25:d58b0595b300 100 void DW1000::stopTRX() {
manumaet 25:d58b0595b300 101 writeRegister8(DW1000_SYS_CTRL, 0, 0x40); // disable tranceiver go back to idle mode
manumaet 17:8afa5f9122da 102 }
manumaet 17:8afa5f9122da 103
manumaet 20:257d56530ae1 104 // PRIVATE Methods ------------------------------------------------------------------------------------
manumaet 18:bbc7ca7d3a95 105 void DW1000::loadLDE() { // initialise LDE algorithm LDELOAD User Manual p22
manumaet 18:bbc7ca7d3a95 106 writeRegister16(DW1000_PMSC, 0, 0x0301); // set clock to XTAL so OTP is reliable
manumaet 20:257d56530ae1 107 writeRegister16(DW1000_OTP_IF, 0x06, 0x8000); // set LDELOAD bit in OTP
manumaet 12:985aa9843c3c 108 wait_us(150);
manumaet 18:bbc7ca7d3a95 109 writeRegister16(DW1000_PMSC, 0, 0x0200); // recover to PLL clock
manumaet 12:985aa9843c3c 110 }
manumaet 12:985aa9843c3c 111
manumaet 12:985aa9843c3c 112 void DW1000::resetRX() {
manumaet 12:985aa9843c3c 113 writeRegister8(DW1000_PMSC, 3, 0xE0); // set RX reset
manumaet 12:985aa9843c3c 114 writeRegister8(DW1000_PMSC, 3, 0xF0); // clear RX reset
manumaet 12:985aa9843c3c 115 }
manumaet 12:985aa9843c3c 116
manumaet 12:985aa9843c3c 117 void DW1000::resetAll() {
manumaet 12:985aa9843c3c 118 writeRegister8(DW1000_PMSC, 0, 0x01); // set clock to XTAL
manumaet 12:985aa9843c3c 119 writeRegister8(DW1000_PMSC, 3, 0x00); // set All reset
manumaet 12:985aa9843c3c 120 wait_us(10); // wait for PLL to lock
manumaet 12:985aa9843c3c 121 writeRegister8(DW1000_PMSC, 3, 0xF0); // clear All reset
manumaet 7:e634eeafc4d2 122 }
manumaet 0:f50e671ffff7 123
manumaet 29:019ff388ed76 124
manumaet 29:019ff388ed76 125 void DW1000::setInterrupt(bool RX, bool TX) {
manumaet 29:019ff388ed76 126 writeRegister16(DW1000_SYS_MASK, 0, RX*0x4000 | TX*0x0080); // RX good frame 0x4000, TX done 0x0080
manumaet 29:019ff388ed76 127 }
manumaet 29:019ff388ed76 128
manumaet 20:257d56530ae1 129 void DW1000::ISR() {
manumaet 20:257d56530ae1 130 uint64_t status = getStatus();
manumaet 22:576ee999b004 131 if (status & 0x4000) { // a frame was received
manumaet 29:019ff388ed76 132 callbackRX.call();
manumaet 22:576ee999b004 133 writeRegister16(DW1000_SYS_STATUS, 0, 0x6F00); // clearing of receiving status bits
manumaet 20:257d56530ae1 134 }
manumaet 22:576ee999b004 135 if (status & 0x80) { // sending complete
manumaet 29:019ff388ed76 136 callbackTX.call();
manumaet 22:576ee999b004 137 writeRegister8(DW1000_SYS_STATUS, 0, 0xF8); // clearing of sending status bits
manumaet 20:257d56530ae1 138 }
manumaet 20:257d56530ae1 139 }
manumaet 20:257d56530ae1 140
manumaet 20:257d56530ae1 141 uint16_t DW1000::getFramelength() {
manumaet 20:257d56530ae1 142 uint16_t framelength = readRegister16(DW1000_RX_FINFO, 0); // get framelength
manumaet 20:257d56530ae1 143 framelength = (framelength & 0x03FF) - 2; // take only the right bits and subtract the 2 CRC Bytes
manumaet 20:257d56530ae1 144 return framelength;
manumaet 20:257d56530ae1 145 }
manumaet 20:257d56530ae1 146
manumaet 0:f50e671ffff7 147 // SPI Interface ------------------------------------------------------------------------------------
manumaet 10:d077bb12d259 148 uint8_t DW1000::readRegister8(uint8_t reg, uint16_t subaddress) {
manumaet 10:d077bb12d259 149 uint8_t result;
manumaet 10:d077bb12d259 150 readRegister(reg, subaddress, &result, 1);
manumaet 10:d077bb12d259 151 return result;
manumaet 10:d077bb12d259 152 }
manumaet 10:d077bb12d259 153
manumaet 18:bbc7ca7d3a95 154 uint16_t DW1000::readRegister16(uint8_t reg, uint16_t subaddress) {
manumaet 18:bbc7ca7d3a95 155 uint16_t result;
manumaet 18:bbc7ca7d3a95 156 readRegister(reg, subaddress, (uint8_t*)&result, 2);
manumaet 18:bbc7ca7d3a95 157 return result;
manumaet 18:bbc7ca7d3a95 158 }
manumaet 18:bbc7ca7d3a95 159
manumaet 18:bbc7ca7d3a95 160 uint64_t DW1000::readRegister40(uint8_t reg, uint16_t subaddress) {
manumaet 18:bbc7ca7d3a95 161 uint64_t result;
manumaet 18:bbc7ca7d3a95 162 readRegister(reg, subaddress, (uint8_t*)&result, 5);
manumaet 18:bbc7ca7d3a95 163 result &= 0xFFFFFFFFFF; // only 40-Bit
manumaet 18:bbc7ca7d3a95 164 return result;
manumaet 18:bbc7ca7d3a95 165 }
manumaet 18:bbc7ca7d3a95 166
manumaet 8:7a9c61242e2f 167 void DW1000::writeRegister8(uint8_t reg, uint16_t subaddress, uint8_t buffer) {
manumaet 8:7a9c61242e2f 168 writeRegister(reg, subaddress, &buffer, 1);
manumaet 8:7a9c61242e2f 169 }
manumaet 8:7a9c61242e2f 170
manumaet 18:bbc7ca7d3a95 171 void DW1000::writeRegister16(uint8_t reg, uint16_t subaddress, uint16_t buffer) {
manumaet 18:bbc7ca7d3a95 172 writeRegister(reg, subaddress, (uint8_t*)&buffer, 2);
manumaet 18:bbc7ca7d3a95 173 }
manumaet 18:bbc7ca7d3a95 174
manumaet 8:7a9c61242e2f 175 void DW1000::readRegister(uint8_t reg, uint16_t subaddress, uint8_t *buffer, int length) {
manumaet 0:f50e671ffff7 176 setupTransaction(reg, subaddress, false);
manumaet 18:bbc7ca7d3a95 177 for(int i=0; i<length; i++) // get data
manumaet 0:f50e671ffff7 178 buffer[i] = spi.write(0x00);
manumaet 0:f50e671ffff7 179 deselect();
manumaet 0:f50e671ffff7 180 }
manumaet 0:f50e671ffff7 181
manumaet 8:7a9c61242e2f 182 void DW1000::writeRegister(uint8_t reg, uint16_t subaddress, uint8_t *buffer, int length) {
manumaet 0:f50e671ffff7 183 setupTransaction(reg, subaddress, true);
manumaet 18:bbc7ca7d3a95 184 for(int i=0; i<length; i++) // put data
manumaet 0:f50e671ffff7 185 spi.write(buffer[i]);
manumaet 0:f50e671ffff7 186 deselect();
manumaet 0:f50e671ffff7 187 }
manumaet 0:f50e671ffff7 188
manumaet 8:7a9c61242e2f 189 void DW1000::setupTransaction(uint8_t reg, uint16_t subaddress, bool write) {
manumaet 18:bbc7ca7d3a95 190 reg |= (write * DW1000_WRITE_FLAG); // set read/write flag
manumaet 0:f50e671ffff7 191 select();
manumaet 0:f50e671ffff7 192 if (subaddress > 0) { // there's a subadress, we need to set flag and send second header byte
manumaet 0:f50e671ffff7 193 spi.write(reg | DW1000_SUBADDRESS_FLAG);
manumaet 18:bbc7ca7d3a95 194 if (subaddress > 0x7F) { // sub address too long, we need to set flag and send third header byte
manumaet 18:bbc7ca7d3a95 195 spi.write((uint8_t)(subaddress & 0x7F) | DW1000_2_SUBADDRESS_FLAG); // and
manumaet 0:f50e671ffff7 196 spi.write((uint8_t)(subaddress >> 7));
manumaet 0:f50e671ffff7 197 } else {
manumaet 0:f50e671ffff7 198 spi.write((uint8_t)subaddress);
manumaet 0:f50e671ffff7 199 }
manumaet 0:f50e671ffff7 200 } else {
manumaet 18:bbc7ca7d3a95 201 spi.write(reg); // say which register address we want to access
manumaet 0:f50e671ffff7 202 }
manumaet 0:f50e671ffff7 203 }
manumaet 0:f50e671ffff7 204
manumaet 18:bbc7ca7d3a95 205 void DW1000::select() { cs = 0; } // set CS low to start transmission
manumaet 18:bbc7ca7d3a95 206 void DW1000::deselect() { cs = 1; } // set CS high to stop transmission