1 / 7

センサー・デバイス (SNS)

Sensor behaviors

センサーや各種デバイスの手続きを定型化したクラスを用意しています。

TWELITE PAL 搭載のセンサーやデバイスを利用する場合は、ボード(BRD)の記載も参照してください。TWELITE PAL 特有の手続きが必要な場合があり、ボード定義に含まれています。

センサー取り扱いのための手続き

温度センサーなど、センサー稼働開始→待ち時間→センサー値の読み出しといった手続きが共通のものもあります。

I2Cセンサーの取り扱い前にWire.begin()を実施しておいてください。スリープ復帰後は、Wireの再初期化は自動で行われるため特別な記述は必要ありません（注：ユーザコード上から明示的に Wire.end() を呼び出した場合は、再初期化を wakeup() に記述します）

void setup() {
  auto&& brd = the_twelite.board.use<PAL_AMB>();
  ..
  Wire.begin();
	brd.sns_SHTC3.begin();
	brd.sns_LTR308ALS.begin();
}

読み出し開始後の手続きはセンサーの種類ごとに違いますが例えば<PAL_AMB>のセンサーは２つとも時間経過を管理します。時間経過をセンサーオブジェクトに伝えるには process_ev() メソッドを用います。

void loop() {
	auto&& brd = the_twelite.board.use<PAL_AMB>();

	// mostly process every ms.
	if (TickTimer.available()) {
		//  wait until sensor capture finish
		if (!brd.sns_LTR308ALS.available()) {
			brd.sns_LTR308ALS.process_ev(E_EVENT_TICK_TIMER);
		}

		if (!brd.sns_SHTC3.available()) {
			brd.sns_SHTC3.process_ev(E_EVENT_TICK_TIMER);
		}
..

上記の例では1msおきのTickTimerを起点にして時間経過を伝えています。E_EVENT_TICK_TIMERはセンサーオブジェクトに1msの経過を伝えるものです。

スリープ復帰などで十分な時間が経過したときは替わりにE_EVENT_START_UPを渡します。センサーオブジェクトは速やかに読み出し可能として処理されます。

いずれの処理も現実世界の時間の経過と一致することを保証しているわけではありません。実際の経過時間が不足している場合は、センサーがエラーを返したり、期待しない値を返すことになります。

センサー共通メソッド

setup()

void setup(uint32_t arg1 = 0, uint32_t arg2 = 0)

センサーの初期化を行います。

begin(), end()

void begin(uint32_t arg1 = 0, uint32_t arg2 = 0)
void end()

センサーの取得を開始, 終了する。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

待ち時間処理のセンサーの場合はarg1にE_EVENT_TICK_TIMERまたはE_EVENT_START_UPを与え時間の経過を知らせます。このメソッド呼出し後に、必要な時間が経過していればavailableになり、センサー値の読み出しが可能になります。

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

（対応しているセンサーのみ）センサーが接続されているときにtrueを返します。

probe()直後の初回の通信が失敗することがある。

SHTC3 - 温湿度センサー

I2Cバスを利用した温湿度センサーです。

ボードビヘイビア <PAL_AMB> を読み込んだ時のみ使用可能です。begin()以外の共通メソッドの手続きはボードビヘイビア中で実行されています。

処理の流れ

Wire.begin(): バスの初期化
.begin(): センサーの動作開始
時間待ち数ms
.available()がtrueになる
.get_temp(), .get_humid(): 値の読み出し

動作に必要な手続き

Wireバス

begin()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

メソッド

get_temp(), get_temp_cent()

double get_temp()
int16_t get_temp_cent()

温度を読み出す。get_temp()は℃で、get_temp_cent()は℃の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

get_humid(), get_humid_per_dmil()

double get_humid()
int16_t get_humid_per_dmil()

湿度を読み出す。get_humid()は%で、get_humid_per_dmil()は%の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

共通メソッド

setup()

void setup()

センサー用のメモリ領域の確保や初期化を行います。

begin(), end()

void begin()
void end()

センサーの取得を開始します。センサーの値を読み出すまで約5ms待ち時間が必要です。

end()には対応しません。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

センサーが接続されているときにtrueを返します。

SHT3x - 温湿度センサー

I2Cバスを利用した温湿度センサーです。

本センサーはTWELITE PALシリーズでは使用されていません。利用例は以下を参照ください。 https://github.com/monowireless/ActEx_Sns_BME280_SHT30

処理の流れ

Wire.begin(): バスの初期化
.setup(): センサーの初期化
.begin(): センサーの動作開始
時間待ち数ms
.available()がtrueになる
.get_temp(), .get_humid(): 値の読み出し

動作に必要な手続き

Wireバス

setup()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

コード例

#include <TWELITE>
#include <SNS_SHT3X>

SNS_SHT3X sns_sht3x; // オブジェクトの宣言

#include <SNS_SHT3X>とSNS_SHT3Xクラスオブジェクトの宣言が必要です。

初期化

void setup() {
    Wire.begin();
    sns_sht3x.setup();
}

センサー値の取得開始

void loop() {

  if(eState == E_STATE::INIT) {
    sns_sht3x.begin();
    eState = E_STATE::CAPTURE;
  }

}

センサー値の取得開始には.begin()を呼び出します。完了まで数msかかります。

※ 上記 loop()内は状態変数eStateにより処理が分岐する設計とします。（参考）

センサー値の取得待ち

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_sht3x.available()) {
      // センサー値読み出し可能
    }
  }

}

センサー値が準備できたかどうかは.available()により判定できます。

センサー値の読み出し

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_sht3x.available()) {
      Serial << crlf << "SHT3X:"
            << " T=" << sns_sht3x.get_temp() << 'C'
						<< " H=" << sns_sht3x.get_humid() << '%';
    }
  }

}

センサー値が準備出来次第、値を読み出すことが出来ます。

.get_temp(), get_humid()は浮動小数点演算が含まれます。100倍整数値を取得することもできます。

auto temp = div100(sns_sht3x.get_temp_cent());
auto humd = div100(sns_sht3x.get_humid_per_dmil);

Serial << crlf << "SHT3X:"
  << format(" T=%c%d.%02d", temp.neg ? '-' : ' ', temp.quo, temp.rem)
  << format(" T=%c%d.%02d", humd.neg ? '-' : ' ', humd.quo, humd.rem);

ここではdiv100()を用いて100倍値を整数部と小数部に分解しています。

メソッド

get_temp(), get_temp_cent()

double get_temp()
int16_t get_temp_cent()

温度を読み出す。get_temp()は℃で、get_temp_cent()は℃の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

get_humid(), get_humid_per_dmil()

double get_humid()
int16_t get_humid_per_dmil()

湿度を読み出す。get_humid()は%で、get_humid_per_dmil()は%の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

共通メソッド

setup()

void setup(uint32_t arg1 = 0UL)

センサー用のメモリ領域の確保や初期化を行います。

arg1のLSBから8bitには、I2Cアドレスを格納することが出来ます。指定しない場合は0としておきます。

#include <SNS_SHT3X>
SNS_SHT3X sns_sht3x;
bool b_found_sht3x = false;

void setup() {
 	sns_sht3x.setup();
	if (!sns_sht3x.probe()) {
		delayMicroseconds(100); // just in case, wait for devices to listen furthre I2C comm.
		sns_sht3x.setup(0x45); // alternative ID
		if (sns_sht3x.probe()) b_found_sht3x = true;
	} else {
		b_found_sht3x = true;
	}
}

上記の例では、まずデフォルトのI2C IDで初期化を試み、応答が無ければ0x45のアドレスでの初期化を試みています。

begin(), end()

void begin()
void end()

センサーの取得を開始します。センサーの値を読み出すまで数ms必要でavailable()がtrueになるまで待つ必要があります。

end()には対応しません。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

待ち時間処理のセンサーの場合はarg1にE_EVENT_TICK_TIMERまたはE_EVENT_START_UPを与え時間の経過を知らせます。このメソッド呼出し後に、必要な時間が経過していればavailable()がtrueになり、センサー値の読み出しが可能になります。

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

センサーが接続されているときにtrueを返します。

sns_stat()

uint32_t sns_stat()

センサーデバイスの諸情報が格納されます。

本デバイスでは格納値は未定義です。

sns_opt()

uint32_t& sns_opt()

setup(uint32_t arg1)で渡した値が格納されています。

下位8bitには指定したI2Cデバイスのアドレスが格納されます。

LTR-308ALS - 照度センサー

I2Cバスを利用した照度センサーです。

ボードビヘイビア <PAL_AMB> を読み込んだ時のみ使用可能です。begin()以外の共通メソッドの手続きはボードビヘイビア中で実行されています。

処理の流れ

Wire.begin(): バスの初期化
.begin(): センサーの動作開始
時間待ち50ms
.available()がtrueになる
.get_luminance(): 値の読み出し

動作に必要な手続き

Wireバス

.begin()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

メソッド

get_luminance()

uint32_t get_luminance()

照度[lx]を整数値で返します。

エラーの時は-1が返ります。

共通メソッド

setup()

void setup()

センサー用のメモリ領域の確保や初期化を行います。

begin(), end()

void begin()
void end()

センサーの取得を開始します。センサーの値を読み出すまで約50ms待ち時間が必要です。

end()には対応しません。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

センサーが接続されているときにtrueを返します。

MC3630 - 加速度センサー

SPIバスを用いた加速度センサーです。

ボードビヘイビア <PAL_MOT> <PAL_NOTICE> を読み込んだ時のみ使用可能です。begin(), available()以外の共通メソッドの手続きはボードビヘイビア中で実行されています。

動作の流れ

.begin(): センサーの動作開始
PIN_SNS_INT割り込みまたは available(): FIFOキューが規定数に達する
.get_que(): FIFOキューからのデータを取得する

動作に必要な手続き

SPI バス

特にありません。

スリープ手続き

PIN_SNS_INT割り込みによる起床を行うため、スリープ前に以下の設定行います。

pinMode(PAL_MOT::PIN_SNS_INT, WAKE_FALLING);

スリープ復帰時の手続き

.wakeup()メソッドの呼び出しが必要です。この処理は<PAL_MOT>ボードビヘイビア中で実行されています。

半導体内部のFIFOキューが一杯になっても読み出さなかった場合は、データ取得は終了し、新たな値は格納されません。

データ構造

各サンプルはaxis_xyzt構造体を要素とするキューsmplqueに格納されます。メンバーx,y,zはそれぞれX,Y,Z軸に対応します。

struct axis_xyzt {
  int16_t x;
  int16_t y;
  int16_t z;
  uint16_t t;
};

各軸の値は1Gを1000とした値として格納されます。tはサンプルの番号で0から順番にサンプルごとに割り振られます。

メソッド

read()

uint8_t read()

半導体のFIFOキューからデータを読み出します。読みだしたバイト数が戻りますが.get_que()で参照するキューのサイズに格納されるデータ数を読み出すようにしてください。

スリープ復帰後に<PAL_MOT>ではread()が行われます。

get_que()

smplque<axis_xyzt>& get_que()

加速度のサンプルを取得します。キューはaxis_xyztを要素としたsmplqueです。availableになってから速やかにキューを空にする必要があります。

共通メソッド

setup()

void setup()

このセンサーではsetup()を使用しません。

begin(), end()

void begin(uint32_t conf)
void end()

confで指定した設定で初期化します。

conf[0:15](bit0-15) : サンプリングモード、conf[16:23] (bit16-23): 加速度のレンジ、conf[24:31] (bit24-31) : 割り込み発生までのサンプル数を設定します。

非公式設定はMC3630のデータシートに記述がないもので設定時の動作は未定義となります。お客様のほうでの動作確認の上利用下さい。非公式設定にかかわる問題やご質問について弊社サポートでは対応いたしかねます。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

このセンサーではprocess_ev()を使用しません。

available()

bool available()

センサーにデータが読み出され内部のキューにデータが保存されているとtrueを戻します。

probe()

bool probe()

このセンサーではprobe()は使用できません。

wakeup()

void wakeup()

スリープ復帰後のSPIバスの再初期化を行い、加速度データを読み出します。

BMx280 - 環境センサー

I2Cバスを利用した気圧・温度・湿度（BME280のみ）センサーです。

本センサーはTWELITE PALシリーズでは使用されていません。利用例は以下を参照ください。 https://github.com/monowireless/ActEx_Sns_BME280_SHT30

処理の流れ

Wire.begin(): バスの初期化
.setup(): センサーの初期化
.begin(): センサーの動作開始
時間待ち数ms
.available()がtrueになる
.get_press(), .get_temp(), .get_humid(): 値の読み出し

動作に必要な手続き

Wireバス

setup()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

コード例

#include <TWELITE>
#include <SNS_BME280>

SNS_BME280 sns_bme280; // オブジェクトの宣言

#include <SNS_SHT3X>とSNS_SHT3Xクラスオブジェクトの宣言が必要です。

初期化

void setup() {
    Wire.begin();
    sns_bme280.setup();
}

センサー値の取得開始

void loop() {

  if(eState == E_STATE::INIT) {
    sns_bme280.begin();
    eState = E_STATE::CAPTURE;
  }

}

センサー値の取得開始には.begin()を呼び出します。完了まで数msかかります。

※ 上記 loop()内は状態変数eStateにより処理が分岐する設計とします。（参考）

センサー値の取得待ち

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_bme280.available()) {
      // センサー値読み出し可能
    }
  }

}

センサー値が準備できたかどうかは.available()により判定できます。

センサー値の読み出し

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_bme280.available()) {
      Serial << crlf << "BMx280:"
            << " P=" << int(sns_bme280.get_press()) << "hP";
            << " T=" << sns_bme280.get_temp() << 'C'
						<< " H=" << sns_bme280.get_humid() << '%';
    }
  }

}

センサー値が準備出来次第、値を読み出すことが出来ます。

.get_temp(), get_humid()は浮動小数点演算が含まれます。100倍整数値を取得することもできます。

auto temp = div100(sns_bme280.get_temp_cent());
auto humd = div100(sns_bme280.get_humid_per_dmil);

Serial << crlf << "BMx280:"
  << " P=" << int(sns_bme280.get_press()) << "hP";
  << format(" T=%c%d.%02d", temp.neg ? '-' : ' ', temp.quo, temp.rem)
  << format(" T=%c%d.%02d", humd.neg ? '-' : ' ', humd.quo, humd.rem);

ここではdiv100()を用いて100倍値を整数部と小数部に分解しています。

メソッド

get_press()

int16_t get_press()

気圧を読み出します。単位はヘクトパスカル(hectopascal )で、通常は1000前後の値を示します。

get_temp(), get_temp_cent()

double get_temp()
int16_t get_temp_cent()

温度を読み出す。get_temp()は℃で、get_temp_cent()は℃の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

get_humid(), get_humid_per_dmil()

double get_humid()
int16_t get_humid_per_dmil()

湿度を読み出す。get_humid()は%で、get_humid_per_dmil()は%の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

共通メソッド

setup()

void setup(uint32_t arg1 = 0UL)

センサー用のメモリ領域の確保や初期化を行います。

arg1のLSBから8bitには、I2Cアドレスを格納することが出来ます。指定しない場合は0としておきます。

#include <SNS_BME280>
SNS_BME280 sns_bme280;
bool b_found_bme280 = false;

void setup() {
  ...
  sns_bme280.setup();
	if (!sns_bme280.probe()) {
			delayMicroseconds(100); // device needs small time for further I2C comm.
			sns_bme280.setup(0x77); // alternative ID
			if (sns_bme280.probe()) b_found_bme280 = true;
	} else {
			b_found_bme280 = true;
	}
	...

上記のコードではまずデフォルトのI2C IDでデバイスが応答するかを試し、応答が無ければ 0x77で試みます。

begin(), end()

void begin()
void end()

センサーの取得を開始します。センサーの値を読み出すまで数ms必要でavailable()がtrueになるまで待つ必要があります。

end()には対応しません。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

センサーが接続されているときにtrueを返します。

sns_stat()

uint32_t sns_stat()

センサーデバイスの諸情報が格納されます。

下位8bitにはBME280/BMP280のチップモデルが格納されます。0x60ならBME280, 0x58ならBMP280となります。

sns_opt()

uint32_t& sns_opt()

setup(uint32_t arg1)で渡した値が格納されています。

下位8bitには指定したI2Cデバイスのアドレスが格納されます。

PCA9632 - LEDドライバ

通知パル (NOTICE PAL) に使用されている LED ドライバです。

通知PAL上での制御はボード(BRD) PAL_NOTICEより行います。

処理の流れ

Wire.begin(): バスの初期化
.setup(): クラスオブジェクトの初期化
.reset(): ドライバの初期化
各種手続き

PCA9632について

4chのLEDドライバです。

各chは消灯・全点灯・PWM点灯・点滅の４つの状態を指定できる
各chで独立して照度制御(PWM)できる
点滅指定したchはすべて同じ点滅パターンとなる
点滅時はPWMによる各ch個別の照度制御ができる

動作に必要な手続き

Wireバス

setup()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

コード例

#include <TWELITE>
#include <SNS_PCA9632>

SNS_PCA9632 pca;

#include <SNS_PCA9632>とSNS_PCA9632クラスオブジェクトの宣言が必要です。

初期化&リセット

void setup() {
    Wire.begin();
    pca.setup();
    pca.reset();
}

点灯

...
   pca.set_led_duty_all(
      127,
      127,
      127,
      127
   );
   
   pca.set_led_status(
      SNS_PCA9632::LED_PWM,
      SNS_PCA9632::LED_NOP,
      SNS_PCA9632::LED_PWM,
      SNS_PCA9632::LED_NOP);

上記の例ではLED1,3をPWM制御により点灯します。

点灯時はドライバが消費する電流値に気を付けてください。

メソッド

コンストラクタ, setup()

SnsPCA9632(uint8_t i2c_addr = DEFAULT_I2C_ADDRESS)
void setup(uint8_t i2c_addr = DEFAULT_I2C_ADDRESS)

コンストラクタではi2c_addrを指定します。

グローバル宣言でクラスオブジェクトを定義した場合、コンストラクタが呼びだされませんので、setup()を呼び出すようにしてください。

reset()

bool reset()

デバイスを初期化します。レジスタアドレス 0x0 から順に {0x81, 0x35, 0x7F, 0x7F, 0x7F, 0x7F, 0x7F, 0x0B, 0x00} を書き込みます。

set_mode2()

bool set_mode2(uint8_t u8var = 0x35)

MODE2レジスタに値を書き込みます。

set_power_mode()

bool set_power_mode(bool b_pow_on)

b_pow_onをtrueにすると通常運用、falseにするとスリープします。

set_blink_cycle() set_blink_cycle_ms()

bool set_blink_cycle(uint8_t u8var)
bool set_blink_cycle_ms(uint16_t u16ms)

点滅(グループPWM)周期を決めます。

u8varを指定すると周期は(u8var+1)/24[秒]となります。

u16msは周期を[ms]で指定します。

set_blink_duty()

bool set_blink_duty(uint8_t u8duty);

点滅(グループPWM)のデューティ比を決めます。点灯期間はu8duty/256となり、0は消灯相当、255は全灯相当になります。

set_led_duty()

bool set_led_duty(uint8_t port, uint8_t duty)

明るさ（PMW制御のデューティ比）を指定します。

portは対象のLED(SNS_PCA9632::LED1..4)を指定します。

dutyは0..255を指定し、比率duty/256で点灯します。

set_led_duty_all()

bool set_led_duty_all(uint8_t p1, uint8_t p2, uint8_t p3, uint8_t p4)

全てのLEDに対して明るさ（PMW制御のデューティ比）を指定します。

p1,p2,p3,p4はLED1..4のデューティで0..255を指定します。比率duty/256で点灯します。

set_led_status()

bool set_led_status(uint8_t u8led1, uint8_t u8led2, uint8_t u8led3, uint8_t u8led4)

全てのLEDの点灯状態を変更します。

u8led1..4は順にLED1..4の状態を指定します。

指定できる状態は、以下の通りです。

probe()

bool probe()

I2Cバス上にデバイスが存在すればtrueを返します。

show_registers()

void show_registers()

レジスタ(0x0-0x8)の値を表示します。

SHT3x - 温湿度センサー

I2Cバスを利用した温湿度センサーです。

本センサーはTWELITE PALシリーズでは使用されていません。利用例は以下を参照ください。 https://github.com/monowireless/ActEx_Sns_BME280_SHT30

処理の流れ

Wire.begin(): バスの初期化
.setup(): センサーの初期化
.begin(): センサーの動作開始
時間待ち数ms
.available()がtrueになる
.get_temp(), .get_humid(): 値の読み出し

動作に必要な手続き

Wireバス

setup()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

コード例

#include <TWELITE>
#include <SNS_SHT3X>

SNS_SHT3X sns_sht3x; // オブジェクトの宣言

#include <SNS_SHT3X>とSNS_SHT3Xクラスオブジェクトの宣言が必要です。

初期化

void setup() {
    Wire.begin();
    sns_sht3x.setup();
}

センサー値の取得開始

void loop() {

  if(eState == E_STATE::INIT) {
    sns_sht3x.begin();
    eState = E_STATE::CAPTURE;
  }

}

センサー値の取得開始には.begin()を呼び出します。完了まで数msかかります。

※ 上記 loop()内は状態変数eStateにより処理が分岐する設計とします。（参考）

センサー値の取得待ち

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_sht3x.available()) {
      // センサー値読み出し可能
    }
  }

}

センサー値が準備できたかどうかは.available()により判定できます。

センサー値の読み出し

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_sht3x.available()) {
      Serial << crlf << "SHT3X:"
            << " T=" << sns_sht3x.get_temp() << 'C'
						<< " H=" << sns_sht3x.get_humid() << '%';
    }
  }

}

センサー値が準備出来次第、値を読み出すことが出来ます。

.get_temp(), get_humid()は浮動小数点演算が含まれます。100倍整数値を取得することもできます。

auto temp = div100(sns_sht3x.get_temp_cent());
auto humd = div100(sns_sht3x.get_humid_per_dmil);

Serial << crlf << "SHT3X:"
  << format(" T=%c%d.%02d", temp.neg ? '-' : ' ', temp.quo, temp.rem)
  << format(" T=%c%d.%02d", humd.neg ? '-' : ' ', humd.quo, humd.rem);

ここではdiv100()を用いて100倍値を整数部と小数部に分解しています。

メソッド

get_temp(), get_temp_cent()

double get_temp()
int16_t get_temp_cent()

温度を読み出す。get_temp()は℃で、get_temp_cent()は℃の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

get_humid(), get_humid_per_dmil()

double get_humid()
int16_t get_humid_per_dmil()

湿度を読み出す。get_humid()は%で、get_humid_per_dmil()は%の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

共通メソッド

setup()

void setup(uint32_t arg1 = 0UL)

センサー用のメモリ領域の確保や初期化を行います。

arg1のLSBから8bitには、I2Cアドレスを格納することが出来ます。指定しない場合は0としておきます。

#include <SNS_SHT3X>
SNS_SHT3X sns_sht3x;
bool b_found_sht3x = false;

void setup() {
 	sns_sht3x.setup();
	if (!sns_sht3x.probe()) {
		delayMicroseconds(100); // just in case, wait for devices to listen furthre I2C comm.
		sns_sht3x.setup(0x45); // alternative ID
		if (sns_sht3x.probe()) b_found_sht3x = true;
	} else {
		b_found_sht3x = true;
	}
}

上記の例では、まずデフォルトのI2C IDで初期化を試み、応答が無ければ0x45のアドレスでの初期化を試みています。

begin(), end()

void begin()
void end()

センサーの取得を開始します。センサーの値を読み出すまで数ms必要でavailable()がtrueになるまで待つ必要があります。

end()には対応しません。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

センサーが接続されているときにtrueを返します。

sns_stat()

uint32_t sns_stat()

センサーデバイスの諸情報が格納されます。

本デバイスでは格納値は未定義です。

sns_opt()

uint32_t& sns_opt()

setup(uint32_t arg1)で渡した値が格納されています。

下位8bitには指定したI2Cデバイスのアドレスが格納されます。

BMx280 - 環境センサー

I2Cバスを利用した気圧・温度・湿度（BME280のみ）センサーです。

本センサーはTWELITE PALシリーズでは使用されていません。利用例は以下を参照ください。 https://github.com/monowireless/ActEx_Sns_BME280_SHT30

処理の流れ

Wire.begin(): バスの初期化
.setup(): センサーの初期化
.begin(): センサーの動作開始
時間待ち数ms
.available()がtrueになる
.get_press(), .get_temp(), .get_humid(): 値の読み出し

動作に必要な手続き

Wireバス

setup()メソッド呼び出し前にWire.begin()によりWireが動作状態にしておきます。

スリープ復帰時の手続き

スリープ直前もWireバスが動作状態にしておきます（スリープ復帰後自動でWireを回復します）。

コード例

#include <TWELITE>
#include <SNS_BME280>

SNS_BME280 sns_bme280; // オブジェクトの宣言

#include <SNS_SHT3X>とSNS_SHT3Xクラスオブジェクトの宣言が必要です。

初期化

void setup() {
    Wire.begin();
    sns_bme280.setup();
}

センサー値の取得開始

void loop() {

  if(eState == E_STATE::INIT) {
    sns_bme280.begin();
    eState = E_STATE::CAPTURE;
  }

}

センサー値の取得開始には.begin()を呼び出します。完了まで数msかかります。

※ 上記 loop()内は状態変数eStateにより処理が分岐する設計とします。（参考）

センサー値の取得待ち

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_bme280.available()) {
      // センサー値読み出し可能
    }
  }

}

センサー値が準備できたかどうかは.available()により判定できます。

センサー値の読み出し

void loop() {

  if(eState == E_STATE::CAPTURE) {
    if (sns_bme280.available()) {
      Serial << crlf << "BMx280:"
            << " P=" << int(sns_bme280.get_press()) << "hP";
            << " T=" << sns_bme280.get_temp() << 'C'
						<< " H=" << sns_bme280.get_humid() << '%';
    }
  }

}

センサー値が準備出来次第、値を読み出すことが出来ます。

.get_temp(), get_humid()は浮動小数点演算が含まれます。100倍整数値を取得することもできます。

auto temp = div100(sns_bme280.get_temp_cent());
auto humd = div100(sns_bme280.get_humid_per_dmil);

Serial << crlf << "BMx280:"
  << " P=" << int(sns_bme280.get_press()) << "hP";
  << format(" T=%c%d.%02d", temp.neg ? '-' : ' ', temp.quo, temp.rem)
  << format(" T=%c%d.%02d", humd.neg ? '-' : ' ', humd.quo, humd.rem);

ここではdiv100()を用いて100倍値を整数部と小数部に分解しています。

メソッド

get_press()

int16_t get_press()

気圧を読み出します。単位はヘクトパスカル(hectopascal )で、通常は1000前後の値を示します。

get_temp(), get_temp_cent()

double get_temp()
int16_t get_temp_cent()

温度を読み出す。get_temp()は℃で、get_temp_cent()は℃の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

get_humid(), get_humid_per_dmil()

double get_humid()
int16_t get_humid_per_dmil()

湿度を読み出す。get_humid()は%で、get_humid_per_dmil()は%の100倍の値を整数値で返します。

エラー時は-32760～-32768の値が返ります。

共通メソッド

setup()

void setup(uint32_t arg1 = 0UL)

センサー用のメモリ領域の確保や初期化を行います。

arg1のLSBから8bitには、I2Cアドレスを格納することが出来ます。指定しない場合は0としておきます。

#include <SNS_BME280>
SNS_BME280 sns_bme280;
bool b_found_bme280 = false;

void setup() {
  ...
  sns_bme280.setup();
	if (!sns_bme280.probe()) {
			delayMicroseconds(100); // device needs small time for further I2C comm.
			sns_bme280.setup(0x77); // alternative ID
			if (sns_bme280.probe()) b_found_bme280 = true;
	} else {
			b_found_bme280 = true;
	}
	...

上記のコードではまずデフォルトのI2C IDでデバイスが応答するかを試し、応答が無ければ 0x77で試みます。

begin(), end()

void begin()
void end()

センサーの取得を開始します。センサーの値を読み出すまで数ms必要でavailable()がtrueになるまで待つ必要があります。

end()には対応しません。

process_ev()

void process_ev(uint32_t arg1, uint32_t arg2 = 0)

available()

bool available()

センサーが読み出し条件を満足したときにtrueを返します。

probe()

bool probe()

センサーが接続されているときにtrueを返します。

sns_stat()

uint32_t sns_stat()

センサーデバイスの諸情報が格納されます。

下位8bitにはBME280/BMP280のチップモデルが格納されます。0x60ならBME280, 0x58ならBMP280となります。

sns_opt()

uint32_t& sns_opt()

setup(uint32_t arg1)で渡した値が格納されています。

下位8bitには指定したI2Cデバイスのアドレスが格納されます。