VindriktningAirQuality.h

/*
 * Copyright (c) 2021, 2022 G. R. McDorman
 *
 * 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.
 */
 
#pragma once
 
#include <SoftwareSerial.h>
 
#include "grmcdorman/device/Device.h"
#include "grmcdorman/device/Accumulator.h"
 
namespace grmcdorman::device
{
    class VindriktningAirQuality: public Device
    {
        public:
            VindriktningAirQuality();
 
            void setup() override;
            void loop() override;
            bool publish(DynamicJsonDocument &json) const override;
            DynamicJsonDocument as_json() const override;
 
            virtual String get_status() const;
 
            uint16_t get_pm25() const
            {
                return pm25.get_last_reading();
            }
        private:
            static constexpr uint16_t vindriktning_message_size = 20;
            void parse(const uint8_t *data);
            bool is_valid_checksum(const uint8_t *data) const;
            const uint8_t *find_message(const uint8_t *data, uint8_t byte_count) const;
 
            enum class State
            {
                NEVER_READ,         
                NO_HEADER_FOUND,    
                READ                
            };
            NoteSetting title;                        
            ExclusiveOptionSetting serialDataPin;     
            InfoSettingHtml device_status;             
 
            ::grmcdorman::SettingInterface::settings_list_t settings;   
 
            SoftwareSerial sensorSerial;                    
            uint32_t last_read_millis = 0;                  
            State last_read_state = State::NEVER_READ;      
            static constexpr uint16_t buffer_size = 2 * vindriktning_message_size;    
            uint8_t buffer[buffer_size];                    
            uint32_t rxBufIdx = 0;                          
 
            static constexpr uint8_t HEADER_BYTE_0 = 0x16;  
            static constexpr uint8_t HEADER_BYTE_1 = 0x11;  
            static constexpr uint8_t HEADER_BYTE_2 = 0x0B;  
 
            Accumulator<uint32_t, 5> pm25;                  
    };
}