A client for the SmartREST protocol from Cumulocity.
Fork of MbedSmartRest by
SmartRest.cpp@0:f76673e7f275, 2014-01-23 (annotated)
- Committer:
- vwochnik
- Date:
- Thu Jan 23 14:36:46 2014 +0000
- Revision:
- 0:f76673e7f275
initial commit, only abstraction
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
vwochnik | 0:f76673e7f275 | 1 | /* |
vwochnik | 0:f76673e7f275 | 2 | * SmartRest.cpp |
vwochnik | 0:f76673e7f275 | 3 | * |
vwochnik | 0:f76673e7f275 | 4 | * Created on: Nov 1, 2013 |
vwochnik | 0:f76673e7f275 | 5 | * * Authors: Vincent Wochnik <v.wochnik@gmail.com> |
vwochnik | 0:f76673e7f275 | 6 | * |
vwochnik | 0:f76673e7f275 | 7 | * Copyright (c) 2013 Cumulocity GmbH |
vwochnik | 0:f76673e7f275 | 8 | * |
vwochnik | 0:f76673e7f275 | 9 | * Permission is hereby granted, free of charge, to any person obtaining |
vwochnik | 0:f76673e7f275 | 10 | * a copy of this software and associated documentation files (the |
vwochnik | 0:f76673e7f275 | 11 | * "Software"), to deal in the Software without restriction, including |
vwochnik | 0:f76673e7f275 | 12 | * without limitation the rights to use, copy, modify, merge, publish, |
vwochnik | 0:f76673e7f275 | 13 | * distribute, sublicense, and/or sell copies of the Software, and to |
vwochnik | 0:f76673e7f275 | 14 | * permit persons to whom the Software is furnished to do so, subject to |
vwochnik | 0:f76673e7f275 | 15 | * the following conditions: |
vwochnik | 0:f76673e7f275 | 16 | * |
vwochnik | 0:f76673e7f275 | 17 | * The above copyright notice and this permission notice shall be |
vwochnik | 0:f76673e7f275 | 18 | * included in all copies or substantial portions of the Software. |
vwochnik | 0:f76673e7f275 | 19 | * |
vwochnik | 0:f76673e7f275 | 20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
vwochnik | 0:f76673e7f275 | 21 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
vwochnik | 0:f76673e7f275 | 22 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
vwochnik | 0:f76673e7f275 | 23 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
vwochnik | 0:f76673e7f275 | 24 | * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
vwochnik | 0:f76673e7f275 | 25 | * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
vwochnik | 0:f76673e7f275 | 26 | * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
vwochnik | 0:f76673e7f275 | 27 | */ |
vwochnik | 0:f76673e7f275 | 28 | |
vwochnik | 0:f76673e7f275 | 29 | #include "SmartRest.h" |
vwochnik | 0:f76673e7f275 | 30 | #include <stdlib.h> |
vwochnik | 0:f76673e7f275 | 31 | #include <stdio.h> |
vwochnik | 0:f76673e7f275 | 32 | #include <string.h> |
vwochnik | 0:f76673e7f275 | 33 | |
vwochnik | 0:f76673e7f275 | 34 | SmartRest::SmartRest(AbstractClient& client, const char *identifier) : _client(client), _identifier(identifier) |
vwochnik | 0:f76673e7f275 | 35 | { |
vwochnik | 0:f76673e7f275 | 36 | _source = NULL; |
vwochnik | 0:f76673e7f275 | 37 | _mogid[0] = 0; |
vwochnik | 0:f76673e7f275 | 38 | } |
vwochnik | 0:f76673e7f275 | 39 | |
vwochnik | 0:f76673e7f275 | 40 | int8_t SmartRest::send(DataGenerator& generator) |
vwochnik | 0:f76673e7f275 | 41 | { |
vwochnik | 0:f76673e7f275 | 42 | uint8_t res; |
vwochnik | 0:f76673e7f275 | 43 | |
vwochnik | 0:f76673e7f275 | 44 | res = beginRequest(); |
vwochnik | 0:f76673e7f275 | 45 | if (res != SMARTREST_SUCCESS) |
vwochnik | 0:f76673e7f275 | 46 | return res; |
vwochnik | 0:f76673e7f275 | 47 | |
vwochnik | 0:f76673e7f275 | 48 | _client.sendData(generator); |
vwochnik | 0:f76673e7f275 | 49 | return awaitResponse(); |
vwochnik | 0:f76673e7f275 | 50 | } |
vwochnik | 0:f76673e7f275 | 51 | |
vwochnik | 0:f76673e7f275 | 52 | int8_t SmartRest::receive(ParsedRecord& record) |
vwochnik | 0:f76673e7f275 | 53 | { |
vwochnik | 0:f76673e7f275 | 54 | uint8_t res; |
vwochnik | 0:f76673e7f275 | 55 | |
vwochnik | 0:f76673e7f275 | 56 | if (_source == NULL) |
vwochnik | 0:f76673e7f275 | 57 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 58 | |
vwochnik | 0:f76673e7f275 | 59 | res = _parser.readFrom(*_source, record); |
vwochnik | 0:f76673e7f275 | 60 | |
vwochnik | 0:f76673e7f275 | 61 | switch (res) { |
vwochnik | 0:f76673e7f275 | 62 | case PARSER_SUCCESS: |
vwochnik | 0:f76673e7f275 | 63 | return SMARTREST_SUCCESS; |
vwochnik | 0:f76673e7f275 | 64 | case PARSER_END_OF_RESPONSE: |
vwochnik | 0:f76673e7f275 | 65 | return SMARTREST_END_OF_RESPONSE; |
vwochnik | 0:f76673e7f275 | 66 | case PARSER_TIMEOUT_ERROR: |
vwochnik | 0:f76673e7f275 | 67 | return SMARTREST_TIMEOUT_ERROR; |
vwochnik | 0:f76673e7f275 | 68 | } |
vwochnik | 0:f76673e7f275 | 69 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 70 | } |
vwochnik | 0:f76673e7f275 | 71 | |
vwochnik | 0:f76673e7f275 | 72 | int8_t SmartRest::bootstrap(DataGenerator& generator) |
vwochnik | 0:f76673e7f275 | 73 | { |
vwochnik | 0:f76673e7f275 | 74 | ParsedRecord record; |
vwochnik | 0:f76673e7f275 | 75 | int8_t ret; |
vwochnik | 0:f76673e7f275 | 76 | |
vwochnik | 0:f76673e7f275 | 77 | ret = beginRequest(); |
vwochnik | 0:f76673e7f275 | 78 | if (ret != SMARTREST_SUCCESS) |
vwochnik | 0:f76673e7f275 | 79 | return ret; |
vwochnik | 0:f76673e7f275 | 80 | ret = awaitResponse(); |
vwochnik | 0:f76673e7f275 | 81 | if (ret != SMARTREST_SUCCESS) |
vwochnik | 0:f76673e7f275 | 82 | return ret; |
vwochnik | 0:f76673e7f275 | 83 | ret = receive(record); |
vwochnik | 0:f76673e7f275 | 84 | if (ret != SMARTREST_SUCCESS) |
vwochnik | 0:f76673e7f275 | 85 | return ret; |
vwochnik | 0:f76673e7f275 | 86 | if (!record) { |
vwochnik | 0:f76673e7f275 | 87 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 88 | } |
vwochnik | 0:f76673e7f275 | 89 | stop(); |
vwochnik | 0:f76673e7f275 | 90 | |
vwochnik | 0:f76673e7f275 | 91 | if (setMoGid(record)) |
vwochnik | 0:f76673e7f275 | 92 | return SMARTREST_SUCCESS; |
vwochnik | 0:f76673e7f275 | 93 | |
vwochnik | 0:f76673e7f275 | 94 | if (record.value(0).integerValue() != 40) { |
vwochnik | 0:f76673e7f275 | 95 | ret = send(generator); |
vwochnik | 0:f76673e7f275 | 96 | if (ret != SMARTREST_SUCCESS) |
vwochnik | 0:f76673e7f275 | 97 | return ret; |
vwochnik | 0:f76673e7f275 | 98 | ret = receive(record); |
vwochnik | 0:f76673e7f275 | 99 | if (ret != SMARTREST_SUCCESS) |
vwochnik | 0:f76673e7f275 | 100 | return ret; |
vwochnik | 0:f76673e7f275 | 101 | stop(); |
vwochnik | 0:f76673e7f275 | 102 | |
vwochnik | 0:f76673e7f275 | 103 | if (setMoGid(record)) |
vwochnik | 0:f76673e7f275 | 104 | return SMARTREST_SUCCESS; |
vwochnik | 0:f76673e7f275 | 105 | } |
vwochnik | 0:f76673e7f275 | 106 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 107 | } |
vwochnik | 0:f76673e7f275 | 108 | |
vwochnik | 0:f76673e7f275 | 109 | void SmartRest::stop() |
vwochnik | 0:f76673e7f275 | 110 | { |
vwochnik | 0:f76673e7f275 | 111 | _source = NULL; |
vwochnik | 0:f76673e7f275 | 112 | _client.stop(); |
vwochnik | 0:f76673e7f275 | 113 | } |
vwochnik | 0:f76673e7f275 | 114 | |
vwochnik | 0:f76673e7f275 | 115 | uint8_t SmartRest::beginRequest() |
vwochnik | 0:f76673e7f275 | 116 | { |
vwochnik | 0:f76673e7f275 | 117 | int res; |
vwochnik | 0:f76673e7f275 | 118 | |
vwochnik | 0:f76673e7f275 | 119 | res = _client.beginRequest(); |
vwochnik | 0:f76673e7f275 | 120 | if (res == CLIENT_CONNECTION_ERROR) { |
vwochnik | 0:f76673e7f275 | 121 | return SMARTREST_CONNECTION_FAILED; |
vwochnik | 0:f76673e7f275 | 122 | } else if (res != CLIENT_OK) { |
vwochnik | 0:f76673e7f275 | 123 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 124 | } |
vwochnik | 0:f76673e7f275 | 125 | if (strlen(_mogid)) { |
vwochnik | 0:f76673e7f275 | 126 | if (_client.sendIdentifier(_mogid) != CLIENT_OK) |
vwochnik | 0:f76673e7f275 | 127 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 128 | } else { |
vwochnik | 0:f76673e7f275 | 129 | if (_client.sendIdentifier(_identifier) != CLIENT_OK) |
vwochnik | 0:f76673e7f275 | 130 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 131 | } |
vwochnik | 0:f76673e7f275 | 132 | return SMARTREST_SUCCESS; |
vwochnik | 0:f76673e7f275 | 133 | } |
vwochnik | 0:f76673e7f275 | 134 | |
vwochnik | 0:f76673e7f275 | 135 | uint8_t SmartRest::awaitResponse() |
vwochnik | 0:f76673e7f275 | 136 | { |
vwochnik | 0:f76673e7f275 | 137 | if ((_client.endRequest() != CLIENT_OK) || |
vwochnik | 0:f76673e7f275 | 138 | (_client.awaitResponse() != CLIENT_OK)) |
vwochnik | 0:f76673e7f275 | 139 | return SMARTREST_INTERNAL_ERROR; |
vwochnik | 0:f76673e7f275 | 140 | _source = &_client.receiveData(); |
vwochnik | 0:f76673e7f275 | 141 | return SMARTREST_SUCCESS; |
vwochnik | 0:f76673e7f275 | 142 | } |
vwochnik | 0:f76673e7f275 | 143 | |
vwochnik | 0:f76673e7f275 | 144 | uint8_t SmartRest::setMoGid(Record& record) |
vwochnik | 0:f76673e7f275 | 145 | { |
vwochnik | 0:f76673e7f275 | 146 | long mogid; |
vwochnik | 0:f76673e7f275 | 147 | |
vwochnik | 0:f76673e7f275 | 148 | *_mogid = 0; |
vwochnik | 0:f76673e7f275 | 149 | |
vwochnik | 0:f76673e7f275 | 150 | if ((record.values() < 2) || (record.value(0).integerValue() != 20)) |
vwochnik | 0:f76673e7f275 | 151 | return 0; |
vwochnik | 0:f76673e7f275 | 152 | |
vwochnik | 0:f76673e7f275 | 153 | if (record.value(1).integerValue() == 0) |
vwochnik | 0:f76673e7f275 | 154 | return 0; |
vwochnik | 0:f76673e7f275 | 155 | |
vwochnik | 0:f76673e7f275 | 156 | mogid = record.value(1).integerValue(); |
vwochnik | 0:f76673e7f275 | 157 | |
vwochnik | 0:f76673e7f275 | 158 | if (!snprintf(_mogid, SMARTREST_MOGID_BUFFER_SIZE, "%ld", mogid)) |
vwochnik | 0:f76673e7f275 | 159 | *_mogid = 0; |
vwochnik | 0:f76673e7f275 | 160 | |
vwochnik | 0:f76673e7f275 | 161 | return 1; |
vwochnik | 0:f76673e7f275 | 162 | } |