Skip to content

Commit

Permalink
Fix #168: enhance TxBuffer_t
Browse files Browse the repository at this point in the history
  • Loading branch information
@terrillmoore
terrillmoore committed Apr 22, 2019
1 parent 4f221dd commit d78a0c1
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 48 deletions.
2 changes: 1 addition & 1 deletion src/CatenaBase.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Revision history:
#define CATENA_ARDUINO_PLATFORM_VERSION_CALC(major, minor, patch, local) \
(((major) << 24u) | ((minor) << 16u) | ((patch) << 8u) | (local))

#define CATENA_ARDUINO_PLATFORM_VERSION CATENA_ARDUINO_PLATFORM_VERSION_CALC(0, 14, 0, 62) /* v0.14.0.62 */
#define CATENA_ARDUINO_PLATFORM_VERSION CATENA_ARDUINO_PLATFORM_VERSION_CALC(0, 14, 0, 63) /* v0.14.0.63 */

#define CATENA_ARDUINO_PLATFORM_VERSION_GET_MAJOR(v) \
(((v) >> 24u) & 0xFFu)
Expand Down
127 changes: 80 additions & 47 deletions src/Catena_TxBuffer.h
View file
Original file line number Diff line number Diff line change
@@ -1,43 +1,15 @@
/* Catena_TxBuffer.h Wed Nov 21 2018 12:33:24 chwon */

/*
Module: Catena_TxBuffer.h
Function:
namespace McciCatena, class TxBuffer_t;
Version:
V0.11.0 Wed Nov 21 2018 12:33:24 chwon Edit level 5
namespace McciCatena, class TxBuffer_t;
Copyright notice:
This file copyright (C) 2016-2018 by
MCCI Corporation
3520 Krums Corners Road
Ithaca, NY 14850
See accompanying license file.
An unpublished work. All rights reserved.
This file is proprietary information, and may not be disclosed or
copied without the prior permission of MCCI Corporation.
Author:
Terry Moore, MCCI Corporation December 2016
Revision history:
0.4.0 Mon Dec 5 2016 00:02:11 tmm
Module created.
0.6.1 Wed Nov 08 2017 22:35:02 tmm
#7: Fix error in handling of negative args to
TxBuffer_t::put2(int32_t) and TxBuffer_t::put2(int32_t).
0.8.0 Sat Feb 03 2018 16:48:02 vel
Added 0x16 Format.
0.11.0 Wed Nov 21 2018 12:33:24 chwon
Added FormatSensor6 (0x18) format.
Terry Moore, MCCI Corporation December 2016
*/

Expand All @@ -49,13 +21,14 @@ Revision history:
namespace McciCatena {

// build a transmit buffer
class TxBuffer_t
template <std::size_t N=32>
class AbstractTxBuffer_t
{
private:
uint8_t buf[32]; // this sets the largest buffer size
uint8_t buf[N]; // this sets the largest buffer size
uint8_t *p;
public:
TxBuffer_t() : p(buf) {};
AbstractTxBuffer_t() : p(buf) {};
void begin()
{
p = buf;
Expand Down Expand Up @@ -118,19 +91,47 @@ class TxBuffer_t
put((uint8_t)(v >> 16));
put((uint8_t)(v >> 8));
put((uint8_t)v);
}
}
// put a 4-byte unsigned integer.
void put4u(uint32_t v)
{
put((uint8_t)(v >> 24));
put((uint8_t)(v >> 16));
put((uint8_t)(v >> 8));
put((uint8_t)v);
}
// put a 4-byte signed integer
void put4s(int32_t v)
{
// just treat the same as uint32_t.
put4u((uint32_t)v);
}
// put a 4-byte IEEE floating point
void put4f(float v)
{
union { uint32_t ui; float f; } x;
x.f = v;
put4u(x.ui);
}
// get address of next byte to be filled
uint8_t *getp(void)
{
return p;
}
size_t getn(void)
std::size_t getn(void)
{
return p - buf;
}
uint8_t *getbase(void)
{
return buf;
}
uint8_t *putflag(uint8_t v)
{
uint8_t * const pResult = p;
put(v);
return pResult;
}
void put2sf(float v)
{
int32_t iv;
Expand Down Expand Up @@ -172,7 +173,7 @@ class TxBuffer_t
}
void putT(float T)
{
put2sf(T * 256.0f + 0.5f);
put2sf(T * 256.0f + 0.5f);
}
void putRH(float RH)
{
Expand Down Expand Up @@ -206,8 +207,17 @@ class TxBuffer_t
{
put2u(fracAsFloat12);
}

// convert a float in [0..1) to unsigned 16-bit float.
static uint16_t f2sflt12(float f);
static uint16_t f2sflt16(float f);
static uint16_t f2uflt12(float f);
static uint16_t f2uflt16(float f);
};

// for backwards compatibilty
using TxBuffer_t = AbstractTxBuffer_t<32>;

/* the magic byte at the front of the buffer */
enum : uint8_t {
FormatSensor1 = 0x11,
Expand All @@ -216,6 +226,7 @@ enum : uint8_t {
FormatSensor4 = 0x16,
FormatSensor5 = 0x17,
FormatSensor6 = 0x18,
FormatSensor7 = 0x19,
};

/* the flags for the second byte of the buffer */
Expand All @@ -228,7 +239,7 @@ enum FlagsSensor1 : uint8_t {
FlagSoilTH = 1 << 5,
};

enum class FlagsSensor2 : uint8_t
enum class FlagsSensor2 : uint8_t
{
FlagVbat = 1 << 0,
FlagVcc = 1 << 1,
Expand All @@ -244,13 +255,13 @@ constexpr FlagsSensor2 operator| (const FlagsSensor2 lhs, const FlagsSensor2 rhs
return FlagsSensor2(uint8_t(lhs) | uint8_t(rhs));
};

FlagsSensor2 operator|= (FlagsSensor2 &lhs, const FlagsSensor2 &rhs)
inline FlagsSensor2 operator|= (FlagsSensor2 &lhs, const FlagsSensor2 &rhs)
{
lhs = lhs | rhs;
return lhs;
};

enum class FlagsSensor3 : uint8_t
enum class FlagsSensor3 : uint8_t
{
FlagVbat = 1 << 0,
FlagVcc = 1 << 1,
Expand All @@ -266,13 +277,13 @@ constexpr FlagsSensor3 operator| (const FlagsSensor3 lhs, const FlagsSensor3 rhs
return FlagsSensor3(uint8_t(lhs) | uint8_t(rhs));
};

FlagsSensor3 operator|= (FlagsSensor3 &lhs, const FlagsSensor3 &rhs)
inline FlagsSensor3 operator|= (FlagsSensor3 &lhs, const FlagsSensor3 &rhs)
{
lhs = lhs | rhs;
return lhs;
};

enum class FlagsSensor4 : uint8_t
enum class FlagsSensor4 : uint8_t
{
FlagVbat = 1 << 0,
FlagVcc = 1 << 1,
Expand All @@ -287,12 +298,12 @@ constexpr FlagsSensor4 operator| (const FlagsSensor4 lhs, const FlagsSensor4 rhs
return FlagsSensor4(uint8_t(lhs) | uint8_t(rhs));
};

FlagsSensor4 operator|= (FlagsSensor4 &lhs, const FlagsSensor4 &rhs)
inline FlagsSensor4 operator|= (FlagsSensor4 &lhs, const FlagsSensor4 &rhs)
{
lhs = lhs | rhs;
return lhs;
};

enum class FlagsSensor5 : uint8_t
{
FlagVbat = 1 << 0,
Expand All @@ -302,15 +313,15 @@ enum class FlagsSensor5 : uint8_t
FlagLux = 1 << 4,
FlagAqi = 1 << 5,
FlagLogGasR = 1 << 6,
FlagAqiAccuracyMisc = 1 << 7,
FlagAqiAccuracyMisc = 1 << 7,
};

constexpr FlagsSensor5 operator| (const FlagsSensor5 lhs, const FlagsSensor5 rhs)
{
return FlagsSensor5(uint8_t(lhs) | uint8_t(rhs));
};

FlagsSensor5 operator|= (FlagsSensor5 &lhs, const FlagsSensor5 &rhs)
inline FlagsSensor5 operator|= (FlagsSensor5 &lhs, const FlagsSensor5 &rhs)
{
lhs = lhs | rhs;
return lhs;
Expand All @@ -328,7 +339,29 @@ constexpr FlagsSensor6 operator| (const FlagsSensor6 lhs, const FlagsSensor6 rhs
return FlagsSensor6(uint8_t(lhs) | uint8_t(rhs));
};

FlagsSensor6 operator|= (FlagsSensor6 &lhs, const FlagsSensor6 &rhs)
inline FlagsSensor6 operator|= (FlagsSensor6 &lhs, const FlagsSensor6 &rhs)
{
lhs = lhs | rhs;
return lhs;
};

enum class FlagsSensor7 : uint8_t
{
FlagVbat = 1 << 0,
FlagBoot = 1 << 1,
FlagError = 1 << 2,
FlagMainPower = 1 << 3,
FlagMainDemand = 1 << 4,
FlagBranchPower = 1 << 5,
FlagBranchDemand = 1 << 6,
};

constexpr FlagsSensor7 operator| (const FlagsSensor7 lhs, const FlagsSensor7 rhs)
{
return FlagsSensor7(uint8_t(lhs) | uint8_t(rhs));
};

inline FlagsSensor7 operator|= (FlagsSensor7 &lhs, const FlagsSensor7 &rhs)
{
lhs = lhs | rhs;
return lhs;
Expand Down
46 changes: 46 additions & 0 deletions src/lib/Catena_TxBuffer.cpp
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
/*
Module: Catena_TxBuffer.cpp
Function:
class McciCatena::TxBuffer_t
Copyright notice:
See accompanying LICENSE file.
Author:
Terry Moore, MCCI Corporation April 2019
Notes:
This module exists primarily to provide linkage of the static
methods to the LMIC implementations.
*/

#include <Catena_TxBuffer.h>
#include <arduino_lmic.h>

namespace McciCatena {

template<>
uint16_t AbstractTxBuffer_t<>::f2sflt12(float f)
{
return LMIC_f2sflt12(f);
}
template<>
uint16_t AbstractTxBuffer_t<>::f2sflt16(float f)
{
return LMIC_f2sflt16(f);
}
template<>
uint16_t AbstractTxBuffer_t<>::f2uflt12(float f)
{
return LMIC_f2uflt12(f);
}
template<>
uint16_t AbstractTxBuffer_t<>::f2uflt16(float f)
{
return LMIC_f2uflt16(f);
}

} // namespace McciCatena

0 comments on commit d78a0c1

Please sign in to comment.