sensor.hpp

Go to the documentation of this file.

#ifndef SENSOR_HPP
#define SENSOR_HPP

#include <string>
#include <sstream>
#include <chrono>

namespace kallisto {
namespace hardware {
class Sensor {
public:
    enum class SensorType {
        /*
         * NOTE: DO NOT FORGET TO UPDATE getValueArraySize(SensorType type) FOR NEW SENSORS
         */

        ACCELEROMETER = 1,
        MAGNETIC_FIELD = 2,
        GYROSCOPE = 4,
        PRESSURE = 6,
        RELATIVE_HUMIDITY = 12,
        AMBIENT_TEMPERATURE = 13,

        /*
         * Custom Sensors
         */

        BATTERY_SOC = 100,
        BATTERY_CHARGING_STATUS = 101,
        RSSI = 102,

        ANALOG = 150,
        CO2_CONCENTRATION = 151,
        TVOC_CONCENTRATION = 152
    };

    enum class ReportingMode {
        REPORTING_MODE_CONTINUOUS = 0,
        REPORTING_MODE_ON_CHANGE = 1,
        REPORTING_MODE_ONE_SHOT = 2,
        REPORTING_MODE_SPECIAL_TRIGGER = 3
    };

protected:
    const unsigned int m_handle; //Unique identifier fot the sensor
    const std::string m_name; //Name of the sensor
    const std::string m_address; //MAC address of the Kallisto that contains this sensor
    const std::string m_vendor; //Sensor vendor
    const unsigned int m_version; //Sensor version
    const SensorType m_type; //Sensor type
    const std::string m_string_type; //String describing a type
    const ReportingMode m_reporting_mode; //Reporting mode
    const unsigned int m_identifier; //Sensor identifier. Allows to distinguish two equal sensors in same Kallisto
    const float m_max_range; //Maximum value measured
    const float m_resolution; //Sensor resolution
    const float m_power; //Power rating
    const std::chrono::microseconds m_min_delay; //Minimum delay between samples, in microseconds
    const std::chrono::microseconds m_max_delay; //Maximum delay between samples, in microseconds

    Sensor(unsigned int handle, std::string name, std::string address, std::string vendor, unsigned int version, SensorType type, std::string string_type, ReportingMode reporting_mode,
                unsigned int identifier, float max_range, float resolution, float power, std::chrono::microseconds min_delay, std::chrono::microseconds max_delay);

    virtual ~Sensor();

    Sensor(Sensor const&) = delete;
    Sensor(Sensor&&) = delete;
    void operator=(Sensor const&) = delete;
    void operator=(Sensor &&) = delete;

public:
    unsigned int getHandle() const;

    std::string getName() const;

    std::string getAddress() const;

    std::string getVendor() const;

    unsigned int getVersion() const;

    SensorType getType() const;

    std::string getStringType() const;

    ReportingMode getReportingMode() const;

    unsigned int getIdentifier() const;

    float getMaximumRange() const;

    float getResolution() const;

    float getPower() const;

    std::chrono::microseconds getMinDelay() const;
    std::chrono::microseconds getMaxDelay() const;

    std::string toString();

    bool operator== (const Sensor &other) const;
    bool operator!= (const Sensor &other) const;
    static unsigned int getValueArraySize(SensorType type);
};

} /* namespace hardware */
} /* namespace kallisto */

#endif // SENSOR_HPP