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.
SDI12_device.h@9:a3062b9e4324, 2018-08-01 (annotated)
- Committer:
- amateusz
- Date:
- Wed Aug 01 18:13:52 2018 +0000
- Revision:
- 9:a3062b9e4324
- Parent:
- 8:1beed160ed13
- Child:
- 10:efd1e313fe8c
stuff
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
amateusz | 0:d58ebb2bed9a | 1 | #include "SDI12.h" |
amateusz | 0:d58ebb2bed9a | 2 | #include <string> |
amateusz | 2:e2db05bc4708 | 3 | #include "mbed.h" |
amateusz | 0:d58ebb2bed9a | 4 | |
amateusz | 0:d58ebb2bed9a | 5 | class SDI12_device |
amateusz | 0:d58ebb2bed9a | 6 | { |
amateusz | 0:d58ebb2bed9a | 7 | public: |
amateusz | 0:d58ebb2bed9a | 8 | struct Identification_struct { |
amateusz | 0:d58ebb2bed9a | 9 | unsigned char sdi_version; |
amateusz | 0:d58ebb2bed9a | 10 | char company[8+1]; |
amateusz | 0:d58ebb2bed9a | 11 | char model[6+1]; |
amateusz | 0:d58ebb2bed9a | 12 | char version[3+1]; |
amateusz | 0:d58ebb2bed9a | 13 | }; |
amateusz | 0:d58ebb2bed9a | 14 | |
amateusz | 0:d58ebb2bed9a | 15 | struct Measurement_struct { |
amateusz | 0:d58ebb2bed9a | 16 | unsigned long timestampMeasurementReadyAt; |
amateusz | 4:11438803516c | 17 | char readyIn; |
amateusz | 0:d58ebb2bed9a | 18 | bool _measurementAlreadyRead; |
amateusz | 0:d58ebb2bed9a | 19 | char count; |
amateusz | 4:11438803516c | 20 | float values[48]; // not float values [] !! :O |
amateusz | 0:d58ebb2bed9a | 21 | }; |
amateusz | 0:d58ebb2bed9a | 22 | |
amateusz | 0:d58ebb2bed9a | 23 | Identification_struct _ident_struct; |
amateusz | 0:d58ebb2bed9a | 24 | |
amateusz | 9:a3062b9e4324 | 25 | static int detect(SDI12 &sdi12, char indices[], int limit = -1){ |
amateusz | 0:d58ebb2bed9a | 26 | char found = 0; |
amateusz | 9:a3062b9e4324 | 27 | for (size_t i = 0; i < (limit==-1?ADDRRICES.size():limit); ++i) { |
amateusz | 7:1f506c65c4e8 | 28 | |
amateusz | 0:d58ebb2bed9a | 29 | string question = "?!"; |
amateusz | 5:e53104570fde | 30 | question[0] = ADDRRICES[i]; |
amateusz | 0:d58ebb2bed9a | 31 | sdi12.sendCommand(question); |
amateusz | 0:d58ebb2bed9a | 32 | std::string response; |
amateusz | 8:1beed160ed13 | 33 | // debug("SEARCHING: %d\r\n", i); |
amateusz | 0:d58ebb2bed9a | 34 | Timer detectTimer; |
amateusz | 0:d58ebb2bed9a | 35 | detectTimer.start(); |
amateusz | 7:1f506c65c4e8 | 36 | while (detectTimer.read_ms() < RESPONSE_TIMEOUT) { |
amateusz | 5:e53104570fde | 37 | if (sdi12.RxInProgress()) detectTimer.reset(); |
amateusz | 7:1f506c65c4e8 | 38 | if (sdi12.RxBufferAvailable()) { |
amateusz | 7:1f506c65c4e8 | 39 | unsigned char bufferSize = sdi12.RxBufferAvailable(); |
amateusz | 7:1f506c65c4e8 | 40 | char buffer[bufferSize]; |
amateusz | 7:1f506c65c4e8 | 41 | sdi12.getRxBuffer(buffer); |
amateusz | 7:1f506c65c4e8 | 42 | // if first char is valid address char |
amateusz | 7:1f506c65c4e8 | 43 | if (ADDRRICES.find(buffer[0])) { |
amateusz | 7:1f506c65c4e8 | 44 | indices[found++] = buffer[0]; |
amateusz | 8:1beed160ed13 | 45 | // debug("FOUND: %d -> %c\r\n", i, indices[found-1]); |
amateusz | 7:1f506c65c4e8 | 46 | } |
amateusz | 7:1f506c65c4e8 | 47 | } |
amateusz | 0:d58ebb2bed9a | 48 | } |
amateusz | 0:d58ebb2bed9a | 49 | } |
amateusz | 0:d58ebb2bed9a | 50 | return found; |
amateusz | 0:d58ebb2bed9a | 51 | }; |
amateusz | 0:d58ebb2bed9a | 52 | |
amateusz | 9:a3062b9e4324 | 53 | SDI12_device (SDI12 &inst, char address, EventQueue &mainDispatcher) : _sdi12(inst),sensorQueue(4*EVENTS_QUEUE_SIZE){ |
amateusz | 0:d58ebb2bed9a | 54 | setAddress(address); |
amateusz | 2:e2db05bc4708 | 55 | sensorQueue.chain(&mainDispatcher); |
amateusz | 1:6b1a21925a81 | 56 | if(getIdentification(_ident_struct)); |
amateusz | 0:d58ebb2bed9a | 57 | }; |
amateusz | 9:a3062b9e4324 | 58 | //~SDI12_device () { |
amateusz | 9:a3062b9e4324 | 59 | // // unchain event queue |
amateusz | 9:a3062b9e4324 | 60 | // sensorQueue.cancel(_measurementEventId); |
amateusz | 9:a3062b9e4324 | 61 | // sensorQueue.chain(NULL); |
amateusz | 9:a3062b9e4324 | 62 | // } |
amateusz | 0:d58ebb2bed9a | 63 | |
amateusz | 2:e2db05bc4708 | 64 | |
amateusz | 0:d58ebb2bed9a | 65 | // // returns after how many seconds a measurement will be ready |
amateusz | 2:e2db05bc4708 | 66 | int measure(bool concurrent = true) { |
amateusz | 4:11438803516c | 67 | |
amateusz | 2:e2db05bc4708 | 68 | std::string question = string("?") + string(concurrent?"C":"M") + string("!"); |
amateusz | 2:e2db05bc4708 | 69 | question[0] = _address; |
amateusz | 2:e2db05bc4708 | 70 | _sdi12.sendCommand(question); |
amateusz | 2:e2db05bc4708 | 71 | |
amateusz | 2:e2db05bc4708 | 72 | Timer timeout; |
amateusz | 2:e2db05bc4708 | 73 | timeout.start(); |
amateusz | 2:e2db05bc4708 | 74 | while (sdi12.RxBufferAvailable() == 0) { |
amateusz | 2:e2db05bc4708 | 75 | if (sdi12.RxInProgress()) timeout.reset(); |
amateusz | 5:e53104570fde | 76 | if(timeout.read_ms() > RESPONSE_TIMEOUT) { |
amateusz | 2:e2db05bc4708 | 77 | return false; |
amateusz | 2:e2db05bc4708 | 78 | } |
amateusz | 2:e2db05bc4708 | 79 | } |
amateusz | 9:a3062b9e4324 | 80 | |
amateusz | 2:e2db05bc4708 | 81 | unsigned char bufferSize = sdi12.RxBufferAvailable(); |
amateusz | 2:e2db05bc4708 | 82 | char buffer[bufferSize+1]; |
amateusz | 2:e2db05bc4708 | 83 | sdi12.getRxBuffer(buffer); |
amateusz | 2:e2db05bc4708 | 84 | buffer[bufferSize] = '\0'; |
amateusz | 2:e2db05bc4708 | 85 | std::string response(buffer); |
amateusz | 2:e2db05bc4708 | 86 | |
amateusz | 2:e2db05bc4708 | 87 | if (response[0] == _address) { |
amateusz | 2:e2db05bc4708 | 88 | char measurementsCount = std::atoi(response.substr(1+3,(concurrent?2:1)).c_str()); |
amateusz | 2:e2db05bc4708 | 89 | char waitFor = std::atoi(response.substr(1,3).c_str()); |
amateusz | 2:e2db05bc4708 | 90 | _measurement.count = measurementsCount; |
amateusz | 4:11438803516c | 91 | _measurement.readyIn = waitFor; |
amateusz | 2:e2db05bc4708 | 92 | // _measurement.timestampMeasurementReadyAt |
amateusz | 2:e2db05bc4708 | 93 | debug("wait for %d measurement for %d seconds...", _measurement.count, waitFor); |
amateusz | 5:e53104570fde | 94 | _measurementEventId = sensorQueue.call_in(waitFor * 1000, callback(this, &SDI12_device::read)); |
amateusz | 9:a3062b9e4324 | 95 | // debug("measurement scheduled"); |
amateusz | 4:11438803516c | 96 | // if (_measurement.values != NULL) delete[] _measurement.values; |
amateusz | 4:11438803516c | 97 | // _measurement.values = new float[measurementsCount]; |
amateusz | 2:e2db05bc4708 | 98 | return 0; |
amateusz | 2:e2db05bc4708 | 99 | } |
amateusz | 2:e2db05bc4708 | 100 | return -1; |
amateusz | 2:e2db05bc4708 | 101 | }; |
amateusz | 0:d58ebb2bed9a | 102 | // |
amateusz | 0:d58ebb2bed9a | 103 | // bool isMeasurementReady(){ |
amateusz | 0:d58ebb2bed9a | 104 | // return (((unsigned)(_measurement.timestampMeasurementReadyAt - millis())>0)?false:true); |
amateusz | 0:d58ebb2bed9a | 105 | // }; |
amateusz | 0:d58ebb2bed9a | 106 | // |
amateusz | 0:d58ebb2bed9a | 107 | // short unsigned int measurementReadyIn(){ // ms |
amateusz | 0:d58ebb2bed9a | 108 | // if (isMeasurementReady()) |
amateusz | 0:d58ebb2bed9a | 109 | // return 0; |
amateusz | 0:d58ebb2bed9a | 110 | // else{ |
amateusz | 0:d58ebb2bed9a | 111 | // return _measurement.timestampMeasurementReadyAt - millis(); |
amateusz | 0:d58ebb2bed9a | 112 | // } |
amateusz | 0:d58ebb2bed9a | 113 | // }; |
amateusz | 0:d58ebb2bed9a | 114 | // |
amateusz | 4:11438803516c | 115 | char readyIn() { |
amateusz | 4:11438803516c | 116 | return _measurement.readyIn; |
amateusz | 4:11438803516c | 117 | } |
amateusz | 4:11438803516c | 118 | |
amateusz | 2:e2db05bc4708 | 119 | bool read() { |
amateusz | 3:2847f7c543d3 | 120 | char valuesAlreadyRead = 0; |
amateusz | 2:e2db05bc4708 | 121 | std::string question = string("?") + string("D0") + string("!"); |
amateusz | 2:e2db05bc4708 | 122 | question[0] = _address; |
amateusz | 2:e2db05bc4708 | 123 | _sdi12.sendCommand(question); |
amateusz | 2:e2db05bc4708 | 124 | |
amateusz | 2:e2db05bc4708 | 125 | Timer timeout; |
amateusz | 2:e2db05bc4708 | 126 | timeout.start(); |
amateusz | 2:e2db05bc4708 | 127 | while (sdi12.RxBufferAvailable() == 0) { |
amateusz | 2:e2db05bc4708 | 128 | if (sdi12.RxInProgress()) timeout.reset(); |
amateusz | 5:e53104570fde | 129 | if(timeout.read_ms() > RESPONSE_TIMEOUT) { |
amateusz | 2:e2db05bc4708 | 130 | return false; |
amateusz | 2:e2db05bc4708 | 131 | } |
amateusz | 2:e2db05bc4708 | 132 | } |
amateusz | 2:e2db05bc4708 | 133 | unsigned char bufferSize = sdi12.RxBufferAvailable(); |
amateusz | 2:e2db05bc4708 | 134 | char buffer[bufferSize+1]; |
amateusz | 2:e2db05bc4708 | 135 | sdi12.getRxBuffer(buffer); |
amateusz | 2:e2db05bc4708 | 136 | buffer[bufferSize] = '\0'; |
amateusz | 2:e2db05bc4708 | 137 | std::string response(buffer); |
amateusz | 2:e2db05bc4708 | 138 | |
amateusz | 4:11438803516c | 139 | // debug("parser. recv: %s\r\n", response); |
amateusz | 3:2847f7c543d3 | 140 | if (response[0] == _address) { |
amateusz | 3:2847f7c543d3 | 141 | // parser here |
amateusz | 3:2847f7c543d3 | 142 | response = response.substr(1); // to limit repeting this operation later. i.e. extract only values e.g. +21.3-123+123 |
amateusz | 3:2847f7c543d3 | 143 | // the only two possible delimeters of a value |
amateusz | 3:2847f7c543d3 | 144 | size_t next_start_index = response.find_first_of("-+", 0); |
amateusz | 3:2847f7c543d3 | 145 | size_t next_end_index; |
amateusz | 3:2847f7c543d3 | 146 | // ready, steady, parse!! |
amateusz | 3:2847f7c543d3 | 147 | while(next_start_index != std::string::npos) { |
amateusz | 3:2847f7c543d3 | 148 | // determine start index: |
amateusz | 3:2847f7c543d3 | 149 | next_end_index = response.find_first_of("-+", next_start_index + 1); // std::substr is prepared to take std::npos |
amateusz | 3:2847f7c543d3 | 150 | float value = std::atof(response.substr(next_start_index, next_end_index).c_str()); |
amateusz | 4:11438803516c | 151 | // debug("parsed: %f\r\n", value); |
amateusz | 4:11438803516c | 152 | _measurement.values[valuesAlreadyRead++] = value; |
amateusz | 3:2847f7c543d3 | 153 | next_start_index = response.find_first_of("-+", next_end_index); |
amateusz | 3:2847f7c543d3 | 154 | } |
amateusz | 3:2847f7c543d3 | 155 | } |
amateusz | 4:11438803516c | 156 | return true; |
amateusz | 2:e2db05bc4708 | 157 | } |
amateusz | 4:11438803516c | 158 | |
amateusz | 4:11438803516c | 159 | |
amateusz | 0:d58ebb2bed9a | 160 | // |
amateusz | 4:11438803516c | 161 | const unsigned char getMeasurementCount() { |
amateusz | 2:e2db05bc4708 | 162 | return _measurement.count; |
amateusz | 2:e2db05bc4708 | 163 | } |
amateusz | 2:e2db05bc4708 | 164 | |
amateusz | 4:11438803516c | 165 | const float getMeasurementValue(char which) { |
amateusz | 2:e2db05bc4708 | 166 | return _measurement.values[which]; |
amateusz | 2:e2db05bc4708 | 167 | } |
amateusz | 2:e2db05bc4708 | 168 | |
amateusz | 0:d58ebb2bed9a | 169 | void setAddress(char address) { |
amateusz | 0:d58ebb2bed9a | 170 | _address = address; |
amateusz | 0:d58ebb2bed9a | 171 | }; |
amateusz | 0:d58ebb2bed9a | 172 | // |
amateusz | 0:d58ebb2bed9a | 173 | // |
amateusz | 0:d58ebb2bed9a | 174 | private: |
amateusz | 5:e53104570fde | 175 | static const int RESPONSE_TIMEOUT = 15+1; // ms |
amateusz | 5:e53104570fde | 176 | static const std::string ADDRRICES; // as in index -> indices, |
amateusz | 5:e53104570fde | 177 | |
amateusz | 0:d58ebb2bed9a | 178 | SDI12 &_sdi12; |
amateusz | 0:d58ebb2bed9a | 179 | char _address; |
amateusz | 5:e53104570fde | 180 | int _measurementEventId; |
amateusz | 0:d58ebb2bed9a | 181 | Measurement_struct _measurement; |
amateusz | 0:d58ebb2bed9a | 182 | |
amateusz | 2:e2db05bc4708 | 183 | EventQueue sensorQueue; |
amateusz | 2:e2db05bc4708 | 184 | |
amateusz | 1:6b1a21925a81 | 185 | bool getIdentification(Identification_struct &ident) { |
amateusz | 1:6b1a21925a81 | 186 | // _sdi12.sendCommand(std::string(_address) + "I!"); |
amateusz | 1:6b1a21925a81 | 187 | std::string question = "?I!"; |
amateusz | 1:6b1a21925a81 | 188 | question[0] = _address; |
amateusz | 1:6b1a21925a81 | 189 | _sdi12.sendCommand(question); |
amateusz | 0:d58ebb2bed9a | 190 | |
amateusz | 1:6b1a21925a81 | 191 | Timer timeout; |
amateusz | 1:6b1a21925a81 | 192 | timeout.start(); |
amateusz | 1:6b1a21925a81 | 193 | while (sdi12.RxBufferAvailable() == 0) { |
amateusz | 1:6b1a21925a81 | 194 | if (sdi12.RxInProgress()) timeout.reset(); |
amateusz | 5:e53104570fde | 195 | if(timeout.read_ms() > RESPONSE_TIMEOUT) { |
amateusz | 1:6b1a21925a81 | 196 | return false; |
amateusz | 1:6b1a21925a81 | 197 | } |
amateusz | 1:6b1a21925a81 | 198 | } |
amateusz | 1:6b1a21925a81 | 199 | unsigned char bufferSize = sdi12.RxBufferAvailable(); |
amateusz | 1:6b1a21925a81 | 200 | char buffer[bufferSize+1]; |
amateusz | 1:6b1a21925a81 | 201 | sdi12.getRxBuffer(buffer); |
amateusz | 1:6b1a21925a81 | 202 | buffer[bufferSize] = '\0'; |
amateusz | 1:6b1a21925a81 | 203 | std::string response(buffer); |
amateusz | 0:d58ebb2bed9a | 204 | |
amateusz | 1:6b1a21925a81 | 205 | if (response[0] == _address) { |
amateusz | 1:6b1a21925a81 | 206 | // e.g.: 113DECAGON GS3 402 |
amateusz | 2:e2db05bc4708 | 207 | |
amateusz | 1:6b1a21925a81 | 208 | ident.sdi_version = std::atoi(response.substr(1, 2).c_str()); |
amateusz | 1:6b1a21925a81 | 209 | std::string tempStr = response.substr(3, 8); |
amateusz | 1:6b1a21925a81 | 210 | strcpy(ident.company, tempStr.c_str()); |
amateusz | 1:6b1a21925a81 | 211 | |
amateusz | 1:6b1a21925a81 | 212 | tempStr = response.substr(3+8, 6); |
amateusz | 1:6b1a21925a81 | 213 | strcpy(ident.model, tempStr.c_str()); |
amateusz | 1:6b1a21925a81 | 214 | |
amateusz | 1:6b1a21925a81 | 215 | tempStr = response.substr(3+8+6, 3); |
amateusz | 1:6b1a21925a81 | 216 | strcpy(ident.version, tempStr.c_str()); |
amateusz | 1:6b1a21925a81 | 217 | return true; |
amateusz | 0:d58ebb2bed9a | 218 | } |
amateusz | 1:6b1a21925a81 | 219 | return false; |
amateusz | 1:6b1a21925a81 | 220 | } |
amateusz | 0:d58ebb2bed9a | 221 | |
amateusz | 5:e53104570fde | 222 | }; |
amateusz | 5:e53104570fde | 223 | |
amateusz | 5:e53104570fde | 224 | const std::string SDI12_device::ADDRRICES = "0123456789abcdefgijklmnoprstuvwxyzABCDEFGHIJKLMNOPRSTUVWXYZ"; |