atMETEO
An ATmega based weather station
Classes | Typedefs | Enumerations | Functions
Sensors Namespace Reference

Namespace containing all symbols of the Sensors library. More...

Classes

struct  BiphaseMark
 Configuration parameter for Demodulator that enables Biphase Mark demodulation. More...
 
class  BitDecoder
 Applies bit numbering and a parity method to transform continuous bit streams (for example from RF demodulation) into bytes. More...
 
class  BitDecoderBase
 BitDecoder base implementation. More...
 
class  Demodulator
 Transforms continuous streams with pulse widths (for example from RF receivers) into bits. More...
 
class  DemodulatorBase
 Demodulator base implementation. More...
 
struct  EvenParity
 Configuration parameter for BitDecoder that enables even parity checking. More...
 
class  HidekiData
 Data class for storing values of a HidekiSensor. More...
 
class  HidekiSensor
 Decodes data received from a Hideki RF 433 MHz sensor. More...
 
struct  LsbBitNumbering
 Configuration parameter for BitDecoder that leads to new bits being added with LSB bit numbering (least significant bit first). More...
 
struct  MsbBitNumbering
 Configuration parameter for BitDecoder that leads to new bits being added with MSB bit numbering (most significant bit first). More...
 
struct  NoParity
 Configuration parameter for BitDecoder that disables parity checking. More...
 
struct  OddParity
 Configuration parameter for BitDecoder that enables odd parity checking. More...
 
class  RfDevice
 Connects Demodulator, Bit Decoder and Sensor for decoding sensor data from RF receivers. More...
 
class  Sensor
 Base class for sensor implementations. More...
 
class  Tgs2600
 Decodes data from Figaro TGS 2600 air contaminants sensors. More...
 

Typedefs

template<template< typename > class TParity, template< typename > class TBitNumbering>
using ByteDecoder = BitDecoder< uint8_t, TParity, TBitNumbering >
 A ByteDecoder is a BitDecoder operating on a single data byte. More...
 
template<uint16_t TShortMin, uint16_t TShortMax, uint16_t TLongMin, uint16_t TLongMax>
using HidekiDevice = RfDevice< Demodulator< BiphaseMark< TShortMin, TShortMax, TLongMin, TLongMax > >, ByteDecoder< EvenParity, LsbBitNumbering >, HidekiSensor, 89 >
 Hideki sensor device implemented using a Sensors::HidekiSensor with the RF 433 MHz reception parameters. More...
 

Enumerations

enum  BitDecoderStatus : uint8_t { BitDecoderStatus::Complete = 0, BitDecoderStatus::Incomplete, BitDecoderStatus::ParityError }
 BitDecoder status returned from BitDecoder::addBit(). More...
 
enum  DemodulatorStatus : uint8_t { DemodulatorStatus::Complete = 0, DemodulatorStatus::Incomplete, DemodulatorStatus::OutOfRangeError }
 Demodulator status returned from DemodulatorBase::addPulseWidth. More...
 
enum  RfDeviceStatus : uint8_t { RfDeviceStatus::Complete = 0, RfDeviceStatus::Incomplete, RfDeviceStatus::InvalidData }
 RfDevice status returned from RfDevice::addPulseWidth(). More...
 
enum  SensorStatus : uint8_t { SensorStatus::Complete = 0, SensorStatus::Incomplete, SensorStatus::TooMuchData, SensorStatus::InvalidData }
 Sensor status returned from Sensor::setData() and Sensor::addByte(). More...
 

Functions

template<typename T >
void bitSet (T &value, uint8_t bit)
 Sets the bit in the given value to 1. More...
 
template<typename T >
void bitClear (T &value, uint8_t bit)
 Sets the bit in the given value to 0. More...
 
template<typename T >
void bitFlip (T &value, uint8_t bit)
 Flips the bit in the given value. More...
 
template<typename T >
bool bitRead (T &value, uint8_t bit)
 Returns the bit in the given value. More...
 
template<typename T >
void bitWrite (T &value, uint8_t bit, bool bitValue)
 Writes the bit in the given value. More...
 
uint8_t byteReverse (uint8_t x)
 Returns the byte x in reversed bit order. More...
 
uint8_t nibbleReverse (uint8_t x)
 Returns the byte x in reversed bit order (nibble wise). More...
 
uint8_t highNibble (uint8_t x)
 Returns the byte's x high nibble. More...
 
uint8_t lowNibble (uint8_t x)
 Returns the byte's x low nibble. More...
 
uint16_t word (uint8_t highByte, uint8_t lowByte)
 Converts two bytes to a word. More...
 
bool parity (int x)
 Returns the even parity for the byte x. More...
 
template<typename T >
min (T a, T b)
 Returns the minimum of the two values a and b. More...
 
template<typename T >
max (T a, T b)
 Returns the maximum of the two values a and b. More...
 

Detailed Description

Namespace containing all symbols of the Sensors library.