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
Outputs/OutputDef.h@0:a29a0225f203, 2012-04-02 (annotated)
- Committer:
- SomeRandomBloke
- Date:
- Mon Apr 02 22:05:20 2012 +0000
- Revision:
- 0:a29a0225f203
- Child:
- 4:d460406ac780
Initial version
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
SomeRandomBloke | 0:a29a0225f203 | 1 | /** IoT Gateway Output definition parent class |
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 _OUTPUTDEF_H |
SomeRandomBloke | 0:a29a0225f203 | 33 | #define _OUTPUTDEF_H |
SomeRandomBloke | 0:a29a0225f203 | 34 | |
SomeRandomBloke | 0:a29a0225f203 | 35 | #include "mbed.h" |
SomeRandomBloke | 0:a29a0225f203 | 36 | |
SomeRandomBloke | 0:a29a0225f203 | 37 | /** Base class for output definitions |
SomeRandomBloke | 0:a29a0225f203 | 38 | * |
SomeRandomBloke | 0:a29a0225f203 | 39 | */ |
SomeRandomBloke | 0:a29a0225f203 | 40 | class OutputDef { |
SomeRandomBloke | 0:a29a0225f203 | 41 | public: |
SomeRandomBloke | 0:a29a0225f203 | 42 | /** Default Constructor |
SomeRandomBloke | 0:a29a0225f203 | 43 | */ |
SomeRandomBloke | 0:a29a0225f203 | 44 | OutputDef(); |
SomeRandomBloke | 0:a29a0225f203 | 45 | |
SomeRandomBloke | 0:a29a0225f203 | 46 | /** Initialise output definition object |
SomeRandomBloke | 0:a29a0225f203 | 47 | */ |
SomeRandomBloke | 0:a29a0225f203 | 48 | virtual void init() = 0; |
SomeRandomBloke | 0:a29a0225f203 | 49 | |
SomeRandomBloke | 0:a29a0225f203 | 50 | /** Add a character pointer reading to output |
SomeRandomBloke | 0:a29a0225f203 | 51 | * |
SomeRandomBloke | 0:a29a0225f203 | 52 | * @param dataFeed The feed to update |
SomeRandomBloke | 0:a29a0225f203 | 53 | * @param dataStream The data stream within the feed to update or null if no feed |
SomeRandomBloke | 0:a29a0225f203 | 54 | * @param reading The new value |
SomeRandomBloke | 0:a29a0225f203 | 55 | */ |
SomeRandomBloke | 0:a29a0225f203 | 56 | virtual void addReading(char *dataFeed, char *dataStream, char *reading ) = 0; |
SomeRandomBloke | 0:a29a0225f203 | 57 | |
SomeRandomBloke | 0:a29a0225f203 | 58 | /** Send any collected readings to the api |
SomeRandomBloke | 0:a29a0225f203 | 59 | * |
SomeRandomBloke | 0:a29a0225f203 | 60 | * @returns -1 for fail, 1 for success |
SomeRandomBloke | 0:a29a0225f203 | 61 | */ |
SomeRandomBloke | 0:a29a0225f203 | 62 | virtual int send( ) = 0; |
SomeRandomBloke | 0:a29a0225f203 | 63 | }; |
SomeRandomBloke | 0:a29a0225f203 | 64 | |
SomeRandomBloke | 0:a29a0225f203 | 65 | #endif /* _OUTPUTDEF_H */ |