SOLID for Raspberry Pi 4 (連載16)

前回はspi_adxl345クレートのインタフェースを、
・init()関数
・regwrite()関数
・regread()関数
としました。

今回は加速度センサADXL345への制御を完全に隠蔽してしまうべく、
・init()関数：ADXL345への初期化を完全に終わらせる
・current_acceleration()関数：X, Y, Z軸の加速度値を取得する（Main関数で計算不要にする）
とします。

1.1 spi_adxl345クレートのinit()関数

これはまったく複雑ではないので、さっと飛ばします。

・pub公開していたinit()関数を、privateとしspi_init()と名称変更する。
・新しくpub公開するinit()関数を作成し、ADXL345への初期化処理を書く。

新しくpub公開するinit()関数は、以下のようになりました。

pub fn init() {
    const BW_RATE: u8 = 0x2c;
    const BW_RATE_VAL: u8 = 0x0b;
    const DATA_FORMAT: u8 = 0x31;
    const DATA_FORMAT_VAL: u8 = 0x0B; //(4 mg/LSB +-16g)
    const POWER_CTL: u8 = 0x2D;
    const POWER_CTL_VAL: u8 = 0x08;

    spi_init();

    //ADXL345_init
    regwrite(BW_RATE, BW_RATE_VAL);
    regwrite(DATA_FORMAT, DATA_FORMAT_VAL);
    regwrite(POWER_CTL, POWER_CTL_VAL);
}

1.2 spi_adxl345クレートにcurrent_acceleration()関数作成

一度呼べば、X, Y, Z軸の加速度値が一気に返ってくる、という関数を作成します。
すなわち、戻り値が複数になる、という事です。

ところで複数の戻り値って、どう書けばいいのでしょう。
配列でポインタ返し？いやポインタはなかったんだっけ。
それともpythonPythonみたいなタプル型ってできたりするのかな？

Cの配列ポインタ返し：

void func1 (int *val)
{
   *val++ = 0x02;
   *val++ = 0x01;
   *val = 0x03;
}

int main() {
   int value[3];
   func1(value);
   return 0;
}

Pythonのタプル型：

def func1():
   return 123, 2, 'string'

Rustではこれら、両方できるようです。

試してみました。

配列返し：

pub fn current_acceleration_array() -> [f32; 3] {
    const DATAX0: u8 = 0x32;
    const DATAY0: u8 = 0x34;
    const DATAZ0: u8 = 0x36;

    let mut axis_array: [f32; 3] = [0.0, 0.0, 0.0];

    //連続複数リードを行う。-> 0xc0とORをとる。
     //0.0392266=(4/1000*9.80665)
    axis_array[0] = regread(0xc0 | DATAX0) as f32 * 0.0392266;
    axis_array[1] = regread(0xc0 | DATAY0) as f32 * 0.0392266;
    axis_array[2] = regread(0xc0 | DATAZ0) as f32 * 0.0392266;

    return axis_array;
}

使う人：
let axis_array: [f32; 3] = spi_adxl345::current_acceleration_array();

タプル型返し：

pub fn current_acceleration_tuple() -> (f32, f32, f32) {
    const DATAX0: u8 = 0x32;
    const DATAY0: u8 = 0x34;
    const DATAZ0: u8 = 0x36;

    //連続複数リードを行う。-> 0xc0とORをとる。
     //0.0392266=(4/1000*9.80665)
    let x_axis = regread(0xc0 | DATAX0) as f32 * 0.0392266;
    let y_axis = regread(0xc0 | DATAY0) as f32 * 0.0392266;
    let z_axis = regread(0xc0 | DATAZ0) as f32 * 0.0392266;

    return  (x_axis, y_axis, z_axis);
}

使う人：
let (x_axis, y_axis, z_axis) = spi_adxl345::current_acceleration_tuple();

ここで一点、気になることがあります。
配列返しの場合の、Rustコードについて、です。

筆者は常日頃から、サブモジュール内でローカル以外の変数を定義することは、なんとなく避けています。
なので、current_acceleration_array()関数内で戻り値となり得るメモリの新設、ここで言うと
let mut axis_array: [f32; 3] = [0.0, 0.0, 0.0];
を行うのに強烈に違和感があるのです。。。

C言語だと、これって
float *axis_array=(float *)malloc(sizeof(float)*3);
をサブルーチンコールの時に毎回行っていて、それを上位で使っています。
こうすると、メモリの解放を忘れがちです。
なんだか危険な匂いがしてきます。

毎度毎度あまり深くは考えてはいませんが、もう体に染みついていて、こういうコードを見ると頭の中で拒否反応が起こってしまいます。
どうしても仕方のない時は、危険信号を察知して十分注意した上でコーディングします。

でも、これはRust。
そうか、これが所有権か！
所有権が上位関数に移って、上位関数でaxis_arrayを使い終わると、そこでライフタイムが終わる、というアレか！

「危険信号を察知して十分注意した上でコーディング」をしないといけないケースがある、という反省を活かして、Rustの言語仕様は作られているのが良くわかります。

ですが、これに慣れてしまうと、C言語に戻れないのかもしれない、という不安も若干。
こういう、体に染みついている危険信号が一旦リセットされてしまうと、C言語に戻ったときにおかしなコードを書きそうな気がします。

そのあたり、Ｃ言語とRust両方のパワーユーザの方に、頭の切り替え方を伝授していただきたいものです。

おっと本筋から離れてしまいました。
これで配列返しもタプル型返しも使えることがわかりました。
配列返しの方が後々使いやすそうなので、そちらを選択することにします。

実行してみます。

SOLID側のUART出力は以下のようになりました。

PCアプリは以下のようになりました。

今回はここまで。

次回は、
・常に最新の加速度値を100個キープしておく
・TCP/IPサーバ経由で、その瞬間の100個の加速度値を送信する
という変更を行う予定です。

これには、（今わかるだけでも）３つ、筆者にとっての試練があります。
その１：加速度値取得をスレッド化
その２：スレッド間のデータ受け渡し
その３：100個キープするためのリングバッファの実装

まだ先が長いなぁ。。。