ClosedCube_SHT31D.h

/*

Particle Photon SHT-3X-DIS Library

ported from

Arduino Library for Sensirion SHT3X-DIS Digital Humidity & Temperature Sensors
Written by AA
---

The MIT License (MIT)

Copyright (c) 2015-2016 ClosedCube Limited

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 CLOSEDCUBE_SHT31D
#define CLOSEDCUBE_SHT31D

#include "application.h"

namespace SHT31D_CC {

	typedef enum {
		CMD_READ_SERIAL_NUMBER = 0x3780,

		CMD_READ_STATUS = 0xF32D,
		CMD_CLEAR_STATUS = 0x3041,

		CMD_HEATER_ENABLE = 0x306D,
		CMD_HEATER_DISABLE = 0x3066,

		CMD_SOFT_RESET = 0x30A2,

		CMD_CLOCK_STRETCH_H = 0x2C06,
		CMD_CLOCK_STRETCH_M = 0x2C0D,
		CMD_CLOCK_STRETCH_L = 0x2C10,

		CMD_POLLING_H = 0x2400,
		CMD_POLLING_M = 0x240B,
		CMD_POLLING_L = 0x2416,

		CMD_ART = 0x2B32,

		CMD_PERIODIC_HALF_H = 0x2032,
		CMD_PERIODIC_HALF_M = 0x2024,
		CMD_PERIODIC_HALF_L = 0x202F,
		CMD_PERIODIC_1_H = 0x2130,
		CMD_PERIODIC_1_M = 0x2126,
		CMD_PERIODIC_1_L = 0x212D,
		CMD_PERIODIC_2_H = 0x2236,
		CMD_PERIODIC_2_M = 0x2220,
		CMD_PERIODIC_2_L = 0x222B,
		CMD_PERIODIC_4_H = 0x2334,
		CMD_PERIODIC_4_M = 0x2322,
		CMD_PERIODIC_4_L = 0x2329,
		CMD_PERIODIC_10_H = 0x2737,
		CMD_PERIODIC_10_M = 0x2721,
		CMD_PERIODIC_10_L = 0x272A,

		CMD_FETCH_DATA = 0xE000,
		CMD_STOP_PERIODIC = 0x3093,

		CMD_READ_ALR_LIMIT_LS = 0xE102,
		CMD_READ_ALR_LIMIT_LC = 0xE109,
		CMD_READ_ALR_LIMIT_HS = 0xE11F,
		CMD_READ_ALR_LIMIT_HC = 0xE114,

		CMD_WRITE_ALR_LIMIT_HS = 0x611D,
		CMD_WRITE_ALR_LIMIT_HC = 0x6116,
		CMD_WRITE_ALR_LIMIT_LC = 0x610B,
		CMD_WRITE_ALR_LIMIT_LS = 0x6100,

		CMD_NO_SLEEP = 0x303E,
	} SHT31D_Commands;


	typedef enum {
		REPEATABILITY_HIGH,
		REPEATABILITY_MEDIUM,
		REPEATABILITY_LOW,
	} SHT31D_Repeatability;

	typedef enum {
		MODE_CLOCK_STRETCH,
		MODE_POLLING,
	} SHT31D_Mode;

	typedef enum {
		FREQUENCY_HZ5,
		FREQUENCY_1HZ,
		FREQUENCY_2HZ,
		FREQUENCY_4HZ,
		FREQUENCY_10HZ
	} SHT31D_Frequency;

	typedef enum {
		NO_ERROR = 0,

		CRC_ERROR = -101,
		TIMEOUT_ERROR = -102,

		PARAM_WRONG_MODE = -501,
		PARAM_WRONG_REPEATABILITY = -502,
		PARAM_WRONG_FREQUENCY = -503,
		PARAM_WRONG_ALERT = -504,

		// Wire I2C translated error codes
		WIRE_I2C_DATA_TOO_LOG = -10,
		WIRE_I2C_RECEIVED_NACK_ON_ADDRESS = -20,
		WIRE_I2C_RECEIVED_NACK_ON_DATA = -30,
		WIRE_I2C_UNKNOW_ERROR = -40
	} SHT31D_ErrorCode;

	typedef union {
		uint16_t rawData;
		struct {
			uint8_t WriteDataChecksumStatus : 1;
			uint8_t CommandStatus : 1;
			uint8_t Reserved0 : 2;
			uint8_t SystemResetDetected : 1;
			uint8_t Reserved1 : 5;
			uint8_t T_TrackingAlert : 1;
			uint8_t RH_TrackingAlert : 1;
			uint8_t Reserved2 : 1;
			uint8_t HeaterStatus : 1;
			uint8_t Reserved3 : 1;
			uint8_t AlertPending : 1;
		};
	} SHT31D_RegisterStatus;

	struct SHT31D {
		float t;
		float rh;
		SHT31D_ErrorCode error;
	};

	class ClosedCube_SHT31D {
	public:
		ClosedCube_SHT31D();

		SHT31D_ErrorCode begin(uint8_t address);
		SHT31D_ErrorCode clearAll();
		SHT31D_RegisterStatus readStatusRegister();

		SHT31D_ErrorCode heaterEnable();
		SHT31D_ErrorCode heaterDisable();

		SHT31D_ErrorCode softReset();
		SHT31D_ErrorCode generalCallReset();

		SHT31D_ErrorCode artEnable();

		uint32_t readSerialNumber();

		SHT31D readTempAndHumidity(SHT31D_Repeatability repeatability, SHT31D_Mode mode, uint8_t timeout);
		SHT31D readTempAndHumidityClockStretch(SHT31D_Repeatability repeatability);
		SHT31D readTempAndHumidityPolling(SHT31D_Repeatability repeatability, uint8_t timeout);

		SHT31D_ErrorCode periodicStart(SHT31D_Repeatability repeatability, SHT31D_Frequency frequency);
		SHT31D periodicFetchData();
		SHT31D_ErrorCode periodicStop();

		SHT31D_ErrorCode writeAlertHigh(float temperatureSet, float temperatureClear, float humiditySet, float humidityClear);
		SHT31D readAlertHighSet();
		SHT31D readAlertHighClear();

		SHT31D_ErrorCode writeAlertLow(float temperatureClear, float temperatureSet, float humidityClear, float humiditySet);
		SHT31D readAlertLowSet();
		SHT31D readAlertLowClear();


	private:
		uint8_t _address;
		SHT31D_RegisterStatus _status;

		SHT31D_ErrorCode writeCommand(SHT31D_Commands command);
		SHT31D_ErrorCode writeAlertData(SHT31D_Commands command, float temperature, float humidity);

		uint8_t checkCrc(uint8_t data[], uint8_t checksum);
		uint8_t calculateCrc(uint8_t data[]);

		float calculateHumidity(uint16_t rawValue);
		float calculateTemperature(uint16_t rawValue);

		uint16_t calculateRawHumidity(float value);
		uint16_t calculateRaWTemperature(float value);

		SHT31D readTemperatureAndHumidity();
		SHT31D readAlertData(SHT31D_Commands command);
		SHT31D_ErrorCode read(uint16_t* data, uint8_t numOfPair);

		SHT31D returnError(SHT31D_ErrorCode command);
	};
}

#endif