mbed based IoT Gateway More details http://blog.thiseldo.co.uk/wp-filez/IoTGateway.pdf
Dependencies: NetServices FatFileSystem csv_parser mbed MQTTClient RF12B DNSResolver SDFileSystem
Payloads/PayloadDef.h@0:a29a0225f203, 2012-04-02 (annotated)
- Committer:
- SomeRandomBloke
- Date:
- Mon Apr 02 22:05:20 2012 +0000
- Revision:
- 0:a29a0225f203
Initial version
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
SomeRandomBloke | 0:a29a0225f203 | 1 | /** IoT Gateway RFM12B payload definition |
SomeRandomBloke | 0:a29a0225f203 | 2 | * |
SomeRandomBloke | 0:a29a0225f203 | 3 | * @author Andrew Lindsay |
SomeRandomBloke | 0:a29a0225f203 | 4 | * |
SomeRandomBloke | 0:a29a0225f203 | 5 | * @section LICENSE |
SomeRandomBloke | 0:a29a0225f203 | 6 | * |
SomeRandomBloke | 0:a29a0225f203 | 7 | * Copyright (c) 2012 Andrew Lindsay (andrew [at] thiseldo [dot] co [dot] uk) |
SomeRandomBloke | 0:a29a0225f203 | 8 | * |
SomeRandomBloke | 0:a29a0225f203 | 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
SomeRandomBloke | 0:a29a0225f203 | 10 | * of this software and associated documentation files (the "Software"), to deal |
SomeRandomBloke | 0:a29a0225f203 | 11 | * in the Software without restriction, including without limitation the rights |
SomeRandomBloke | 0:a29a0225f203 | 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
SomeRandomBloke | 0:a29a0225f203 | 13 | * copies of the Software, and to permit persons to whom the Software is |
SomeRandomBloke | 0:a29a0225f203 | 14 | * furnished to do so, subject to the following conditions: |
SomeRandomBloke | 0:a29a0225f203 | 15 | |
SomeRandomBloke | 0:a29a0225f203 | 16 | * The above copyright notice and this permission notice shall be included in |
SomeRandomBloke | 0:a29a0225f203 | 17 | * all copies or substantial portions of the Software. |
SomeRandomBloke | 0:a29a0225f203 | 18 | * |
SomeRandomBloke | 0:a29a0225f203 | 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
SomeRandomBloke | 0:a29a0225f203 | 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
SomeRandomBloke | 0:a29a0225f203 | 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
SomeRandomBloke | 0:a29a0225f203 | 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
SomeRandomBloke | 0:a29a0225f203 | 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
SomeRandomBloke | 0:a29a0225f203 | 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
SomeRandomBloke | 0:a29a0225f203 | 25 | * THE SOFTWARE. |
SomeRandomBloke | 0:a29a0225f203 | 26 | * |
SomeRandomBloke | 0:a29a0225f203 | 27 | * @section DESCRIPTION |
SomeRandomBloke | 0:a29a0225f203 | 28 | * |
SomeRandomBloke | 0:a29a0225f203 | 29 | * |
SomeRandomBloke | 0:a29a0225f203 | 30 | */ |
SomeRandomBloke | 0:a29a0225f203 | 31 | |
SomeRandomBloke | 0:a29a0225f203 | 32 | #ifndef _PAYLOADDEF_H |
SomeRandomBloke | 0:a29a0225f203 | 33 | #define _PAYLOADDEF_H |
SomeRandomBloke | 0:a29a0225f203 | 34 | |
SomeRandomBloke | 0:a29a0225f203 | 35 | #include "mbed.h" |
SomeRandomBloke | 0:a29a0225f203 | 36 | |
SomeRandomBloke | 0:a29a0225f203 | 37 | #define MAX_PAYLOAD_SIZE 76 |
SomeRandomBloke | 0:a29a0225f203 | 38 | |
SomeRandomBloke | 0:a29a0225f203 | 39 | /** Payload definition base class |
SomeRandomBloke | 0:a29a0225f203 | 40 | */ |
SomeRandomBloke | 0:a29a0225f203 | 41 | class PayloadDef { |
SomeRandomBloke | 0:a29a0225f203 | 42 | public: |
SomeRandomBloke | 0:a29a0225f203 | 43 | /** Default Constructor |
SomeRandomBloke | 0:a29a0225f203 | 44 | */ |
SomeRandomBloke | 0:a29a0225f203 | 45 | PayloadDef(); |
SomeRandomBloke | 0:a29a0225f203 | 46 | |
SomeRandomBloke | 0:a29a0225f203 | 47 | /** Alternative constructor for passing payload |
SomeRandomBloke | 0:a29a0225f203 | 48 | * |
SomeRandomBloke | 0:a29a0225f203 | 49 | * @param pptr Pointer to payload data |
SomeRandomBloke | 0:a29a0225f203 | 50 | * @param plen Length of paylod data |
SomeRandomBloke | 0:a29a0225f203 | 51 | */ |
SomeRandomBloke | 0:a29a0225f203 | 52 | PayloadDef( uint8_t *pptr, short plen ); |
SomeRandomBloke | 0:a29a0225f203 | 53 | |
SomeRandomBloke | 0:a29a0225f203 | 54 | /** Get the number of readings in a payload |
SomeRandomBloke | 0:a29a0225f203 | 55 | * |
SomeRandomBloke | 0:a29a0225f203 | 56 | * @returns the number of readings found in payload so they can be read |
SomeRandomBloke | 0:a29a0225f203 | 57 | */ |
SomeRandomBloke | 0:a29a0225f203 | 58 | virtual short numReadings() = 0; |
SomeRandomBloke | 0:a29a0225f203 | 59 | |
SomeRandomBloke | 0:a29a0225f203 | 60 | /** Get a single reading from the payload |
SomeRandomBloke | 0:a29a0225f203 | 61 | * Other payload definition classes may provide alternative versions for bytes, words or strings |
SomeRandomBloke | 0:a29a0225f203 | 62 | * |
SomeRandomBloke | 0:a29a0225f203 | 63 | * @param readingNum The number of the reading, starts from 0 upto number of readings in payload |
SomeRandomBloke | 0:a29a0225f203 | 64 | * @returns Integer representation of reading |
SomeRandomBloke | 0:a29a0225f203 | 65 | */ |
SomeRandomBloke | 0:a29a0225f203 | 66 | virtual int reading( short readingNum ) = 0; |
SomeRandomBloke | 0:a29a0225f203 | 67 | |
SomeRandomBloke | 0:a29a0225f203 | 68 | /** Get the sensor ID for the specified reading within the payload |
SomeRandomBloke | 0:a29a0225f203 | 69 | * Other payload definition classes may provide alternative versions for bytes, words or strings |
SomeRandomBloke | 0:a29a0225f203 | 70 | * |
SomeRandomBloke | 0:a29a0225f203 | 71 | * @param readingNum The number of the reading, starts from 0 upto number of readings in payload |
SomeRandomBloke | 0:a29a0225f203 | 72 | * @returns Integer representation of reading |
SomeRandomBloke | 0:a29a0225f203 | 73 | */ |
SomeRandomBloke | 0:a29a0225f203 | 74 | virtual short sensorId( short readingNum ) = 0; |
SomeRandomBloke | 0:a29a0225f203 | 75 | |
SomeRandomBloke | 0:a29a0225f203 | 76 | /** Get the node ID from the data header |
SomeRandomBloke | 0:a29a0225f203 | 77 | * |
SomeRandomBloke | 0:a29a0225f203 | 78 | * @returns Single byte Node ID from the received header data |
SomeRandomBloke | 0:a29a0225f203 | 79 | */ |
SomeRandomBloke | 0:a29a0225f203 | 80 | uint8_t nodeId(); |
SomeRandomBloke | 0:a29a0225f203 | 81 | |
SomeRandomBloke | 0:a29a0225f203 | 82 | /** Get the group ID from the data header |
SomeRandomBloke | 0:a29a0225f203 | 83 | * |
SomeRandomBloke | 0:a29a0225f203 | 84 | * @returns Single byte Group ID from the received header data |
SomeRandomBloke | 0:a29a0225f203 | 85 | */ |
SomeRandomBloke | 0:a29a0225f203 | 86 | uint8_t groupId(); |
SomeRandomBloke | 0:a29a0225f203 | 87 | |
SomeRandomBloke | 0:a29a0225f203 | 88 | protected: |
SomeRandomBloke | 0:a29a0225f203 | 89 | short readingCount; |
SomeRandomBloke | 0:a29a0225f203 | 90 | short payloadLen; |
SomeRandomBloke | 0:a29a0225f203 | 91 | uint8_t payloadBuffer[MAX_PAYLOAD_SIZE]; |
SomeRandomBloke | 0:a29a0225f203 | 92 | |
SomeRandomBloke | 0:a29a0225f203 | 93 | }; |
SomeRandomBloke | 0:a29a0225f203 | 94 | |
SomeRandomBloke | 0:a29a0225f203 | 95 | #endif /* _PAYLOADDEF_H */ |