Andrew Lindsay / Mbed 2 deprecated IoTGateway_Basic

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.

Dependencies:   NetServices FatFileSystem csv_parser mbed MQTTClient RF12B DNSResolver SDFileSystem

Embed: (wiki syntax)

« Back to documentation index

PayloadV1 Class Reference
Public Member Functions

PayloadV1 Class Reference

Payload format class Format of each reading is defined above with first byte of payload being a status byte. More...

#include <PayloadV1.h>

Inherits PayloadDef.

Public Member Functions

 PayloadV1 ()
 Default Constructor.
 PayloadV1 (uint8_t *pptr, short plen)
 Alternative constructor for passing payload details.
virtual short numReadings ()
 Get the number of readings in a payload.
virtual int reading (short readingNum)
 Get a single reading from the payload.
virtual short sensorId (short readingNum)
 Get the sensor ID for the specified reading within the payload.
uint8_t nodeId ()
 Get the node ID from the data header.
uint8_t groupId ()
 Get the group ID from the data header.

Detailed Description

Payload format class Format of each reading is defined above with first byte of payload being a status byte.

Definition at line 51 of file PayloadV1.h.

Constructor & Destructor Documentation

PayloadV1 (  )

Default Constructor.

IoT Gateway RFM12B payload V1 format handling.

Author:
Andrew Lindsay

LICENSE

Copyright (c) 2012 Andrew Lindsay (andrew [at] thiseldo [dot] co [dot] uk)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

DESCRIPTION

Definition at line 38 of file PayloadV1.cpp.

PayloadV1 ( uint8_t *  pptr,
short  plen 
)

Alternative constructor for passing payload details.

Parameters:
pptrPointer to payload data
plenLength of paylod data

Definition at line 39 of file PayloadV1.cpp.

Member Function Documentation

uint8_t groupId (  ) [inherited]

Get the group ID from the data header.

Returns:
Single byte Group ID from the received header data

Definition at line 54 of file PayloadDef.cpp.

uint8_t nodeId (  ) [inherited]

Get the node ID from the data header.

Returns:
Single byte Node ID from the received header data

Definition at line 50 of file PayloadDef.cpp.

short numReadings (  ) [virtual]

Get the number of readings in a payload.

Returns:
the number of readings found in payload so they can be read

Implements PayloadDef.

Definition at line 43 of file PayloadV1.cpp.

int reading ( short  readingNum ) [virtual]

Get a single reading from the payload.

Parameters:
readingNumThe number of the reading, starts from 0 upto number of readings in payload
Returns:
Integer representation of reading

Implements PayloadDef.

Definition at line 47 of file PayloadV1.cpp.

short sensorId ( short  readingNum ) [virtual]

Get the sensor ID for the specified reading within the payload.

Parameters:
readingNumThe number of the reading, starts from 0 upto number of readings in payload
Returns:
Integer representation of reading

Implements PayloadDef.

Definition at line 52 of file PayloadV1.cpp.

Generated on Tue Jul 12 2022 22:07:04 by  doxygen 1.7.2