1 / 17

関数

システム関数

millis()

システム時刻[ms]を得ます。

uint32_t millis()

システム時刻はTickTimerの割り込みで更新されます。

delay()

ポーリングによる時間待ちを行います。

void delay(uint32_t ms)

msにて与えられた期間待ち処理を行います。

時間の計測はTickTimerのカウントによって行っています。また長い時間待ちを行う場合はCPUのクロックを低下してポーリング処理を行います。

delay()を呼び出してから約5ms経過するごとにTWELITEマイコン内部のウォッチドッグ処理を行います。

※例えばwhile(1) delay(1); を実行した場合は、delay()内部で5ms経過しないためウォッチドッグ処理が行われず、一定時間後リセットが実行されます。

setup(), wakeup()関数内では、TickTimerがまだ動作していないため、whileループによる時間待ち処理になります。この場合、指定値との誤差は大きくなります。このループカウンタは32Mhzに合わせて調整しています。これら関数内でCPUクロックを変化させた場合は、そのクロックに比例した誤差が発生します。

パラメータに1,2といった短い時間を指定した場合は、誤差が大きくなる場合があります。

random()

乱数を生成します。

１行目は0..(maxval-1)の値を戻します。maxvalの値が最大値ではないことに注意してください。

２行目はminval..maxval-1の値を戻します。

DIO 汎用ディジタルIO

汎用ディジタルIO（DIO）の操作には以下の関数を利用します。

pinMode()
digitalWrite()
digitalRead()
attachIntDio()
detachIntDio()

定数

ピン名と番号

ピンのモード（DIO0..19)

以下の列挙値は型名 E_PIN_MODEで取り扱われます。

ピンのモード（DO0,1)

以下の列挙値は型名 E_PIN_MODEで取り扱われます。

ピンの状態

以下の列挙値は型名 E_PIN_STATEで取り扱われます。

ピンの立ち上がり、立下り

以下の列挙値は型名 E_PIN_INT_MODEで取り扱われます。

pinMode()

DIO(汎用ディジタルIO)ピンの設定を行います。

void pinMode(uint8_t u8pin, E_PIN_MODE mode)

この関数では DIO0..19 と、DO0,1のピンの状態を変更できます。設定内容は E_PIN_MODE の列挙値のDIOの解説とDOの解説を参照してください。

DO0,1は特殊なピンで、原則として他の目的で利用されるものですが、出力としても設定可能です。ただしハード的な制約があるピンですので、利用には注意が必要です。

両方のピンは、電源投入時にHIGHレベルが担保される必要があります。不安定な電圧をとったりするような回路構成の場合、モジュールが起動しないなどの問題が出ます。

digitalWrite()

ディジタル出力ピンの設定を変更します。

static inline void digitalWrite(uint8_t u8pin, E_PIN_STATE ulVal)

事前にpinMode()にて設定対象のピンを出力用に設定しておきます。１番目のパラメータは、設定対象のピン番号を指定します。２番目のパラメータはHIGHかLOWのいずれかを指定します。

入力が E_PIN_STATE 型となっています。E_PIN_STATEからint型への変換演算子は定義していませんので、数値による直接の入力はできないようになっています。

digitalRead()

入力設定のポートの値を読み出す。

static inline E_PIN_STATE digitalRead(uint8_t u8pin)

事前に入力に設定したピンの入力値をLOWまたはHIGHで得ます。

E_PIN_STATE型からint型への変換演算子は定義していないため、数値型への直接的な代入はできません。

attachIntDio()

DIO割り込みを有効にします。

void attachIntDio(uint8_t u8pin, E_PIN_INT_MODE mode)

事前に入力設定したピンに対して、１番目のパラメータは割り込みを有効にしたいピン番号で、２番目は割り込み方向（立ち上がり、立ち下がり）を指定します。

割り込みハンドラ、イベントハンドラの記述はアプリケーションビヘイビアで行います。

例

DIO5のピンがHIGHからLOWに変化したときに割り込みが発生する設定を行う。

void setup() {
  the_twelite.app.use<myAppClass>();
  
  pinMode(PIN_DIGITAL::DIO5, PIN_MODE::INPUT_PULLUP);
  attachIntDio(PIN_DIGITAL::DIO5, PIN_INT_MODE::FALLING);
}

void loop() {
  ;
}

myAppClass.hpp

class myAppClass: public mwx::BrdPal, MWX_APPDEFS_CRTP(myAppClasslMot)
{

};

アプリケーションビヘイビアmyAppClassの基本定義。詳細は省略している。

myAppClass.cpp

/*****************************************************************/
// MUST DEFINE CLASS NAME HERE
#define __MWX_APP_CLASS_NAME myAppClass
#include "_mwx_cbs_cpphead.hpp"
/*****************************************************************/

MWX_DIO_INT(PIN_DIGITAL::DIO5, uint32_t arg, uint8_t& handled) {
  static uint8_t ct;
  digitalWrite(PIN_DIGITAL::DIO12, (++ct & 1) ? HIGH : LOW);
	handled = false; // if true, no further event.
}

MWX_DIO_EVENT(PIN_DIGITAL::DIO5, uint32_t arg) {
  Serial << '*';	
}

/*****************************************************************/
// common procedure (DO NOT REMOVE)
#include "_mwx_cbs_cpptail.cpp"
// MUST UNDEF CLASS NAME HERE
#undef __MWX_APP_CLASS_NAME
} // mwx
/*****************************************************************/

アプリケーションビヘイビアmyAppClassの割り込みハンドラの記述。DIO5の割り込み発生時にDIO12の出力設定を反転させ、割り込みハンドラが終了してから発生するイベントではシリアルポートSerialに*を表示する。

detachIntDio()

割り込みハンドラの登録を解除します。

void detachIntDio(uint8_t u8pin)

ユーティリティ関数

pack_bits()

指定したビット位置に1をセットします。

constexpr uint32_t pack_bits(...)

パラメータは可変数引数で指定でき、各パラメータはビット位置を指定する0..31の整数を指定する。例えばpack_bits(1,3,6)と指定すると((1UL<<1)|(1UL<<3)|(1UL<<6))を返します。

constexprは定数による計算が可能な場合はコンパイル時に定数展開します。

collect_bits()

整数から指定したビット位置の値を取得し、指定した順番のビットマップを作成します。

constexpr uint32_t collect_bits(uint32_t bm, ...)

パラメータbmに指定する値から、その後の可変数パラメータで指定する0..31のビット位置に対応する値を取り出します。取り出した値はパラメータ順に並べビットマップとして戻り値になります。

ビットマップの並び順は、最初のパラメータを上位ビットとし末尾のパラメータがbit0になります。

uint32_t b1 = 0x12; // (b00010010)
uint32_t b2 = collect_bits(b1, 4, 2, 1, 0); 
  // bit4->1, bit2->0, bit1->1, bit0->0
  // b2=0x10 (b1010)

例ではb1のビット4,2,1,0を取り出すと (1,0,1,0) になります。これをb1010として0x10のように計算されます。

pack_bytes()

要素データを並べてバイト列を生成します。

pack_bytesはコンテナクラスのbegin(),end()イテレータをパラメータとし、続くパラメータで指定されるデータをバイト列としてコンテナに書き込みます。

可変引数パラメータに与えるデータは以下に示すとおりです。

pack_bytesはコンテナオブジェクトをパラメータとし、続くパラメータで指定されるデータをバイト列としてコンテナに書き込みます。コンテナの.push_back()メソッドで末尾に追加します。

可変引数パラメータに与えるデータは以下に示すとおりです。

例

この例では受信パケットの各属性やペイロードを別のバッファbufに再格納しています。

expand_bytes()

バイト列を分解し変数に格納します。

expand_bytes()は、パラメータにuint8_t*型のイテレータの組み合わせを指定します。これは解析対象の先頭と末尾の次のイテレータの指定となります。eの位置まで解析が進んだ場合はエラーとなりnullptrを返します。

展開にエラーがない場合は、次の読み出しを行うイテレータを戻します。

可変数パラメータには以下を指定します。

例

この例では、まず４バイトの文字列を読み出しています。ここではmake_pair()を用いて明示的に４バイト分のデータを読み出します。

戻されたイテレータnpをもとに、次のデータを読み出します。次のデータはuint8_t型、あとはuint16_t型が５つ続いています。

CRC8, XOR, LRC

チェックサムの計算で良く用いられる値です。

CRC8, XOR, LRC(で使用)の計算を行います。

CRC8_u8CalcU16(), CRC8_u8CalcU32()はu16c, u32cをビッグエンディアン並びとして、CRC8を計算します。

CRC8は、計算式や初期値などによって種類がありますが、本ライブラリでは多項式をX^8+X^5+X^4+1(Polynomial Valueを0x31)をとしたものを使用しています。これはCRC8-CCITT や CRC8-Maximと呼ばれることがあります。

XORは各要素の排他的論理和 XOR をとったものです。

LRCは各要素の値の合計を計算し、下位８ビットの２の補数を取ります。結果、チェックサムを含め全要素を足し算すると０になります。