ErriezBH1750.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2020 Erriez
 *
 * 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.
 */

#ifndef ERRIEZ_BH1750_H__
#define ERRIEZ_BH1750_H__

#include <Arduino.h>
#include <Wire.h>

typedef enum {
    ModeContinuous = 0x10,  
    ModeOneTime = 0x20,     
} BH1750_Mode_e;

typedef enum {
    ResolutionLow = 0x03,  
    ResolutionMid = 0x00,  
    ResolutionHigh = 0x01, 
} BH1750_Resolution_e;

class BH1750
{
public:
    explicit BH1750(uint8_t addrPinLevel=LOW);
    void begin(BH1750_Mode_e mode, BH1750_Resolution_e resolution);
    void powerDown();
    void startConversion();
    bool isConversionCompleted();
    bool waitForCompletion();
    uint16_t read();

protected:
    void writeInstruction(uint8_t instruction);
    void setTimestamp();

private:
    unsigned long _completionTimestamp;
    uint8_t _i2cAddr;
    uint8_t _mode;
};

#endif // ERRIEZ_BH1750_H__