MIRS0103 Specification

沼津高専電子制御工学科

MIRS0103ソフトウェア詳細設計書
MIRS0103-SOFT-0001

改訂記録

版数

作成日

作成者

承認

改訂内容

A01

2002.5.10

中村、花島、山本

中村

初版

A02

2002.6.3

中村

モードの説明の追加
エラー処理関連の追加
それに伴う図の変更、差し替え

A03

2002.12.13

花島

中村

ライブラリの説明の修正

A04

2002.12.17

花島

中村

ライブラリの説明の修正

A05

2003.2.12

山本

中村

プログラムの仕様変更に伴うフローチャートおよび行動詳細の改定

はじめに
概要
OS（RT-Linux）の概要
プログラム群の構成
プログラム群の詳細
試験
1. 標準MIRS上での試験
2. 実機上での試験

はじめに
本ドキュメントは、MIRS0103基本設計書に規定されたシステムの動作規定、状態遷移を実現する各タスクの開発（コーディング、試験等）に必要な事項を述べる。
概要
MIRS0103 ソフトウェアは、RT-Linux 上で動作するプログラム群で構成される。プログラムはC言語でかかれ、Linux の標準の API とともに、行動モードに対応したプログラム、一つの機能を複数のプログラム群で提供する機能モジュール、および、RTタスク、ドライバと、補助関数と独自に定義したヘッダファイルから構成される。
OS(RT-Linux)の概要
調査報告書参照
プログラム群の構成
プログラム群の詳細
1. モード
  
  各モードの動作を示す関数は引数にMIRS構造体へのポインタをとる。 MIRS構造体はMIRSの動作状態を示す変数をまとめたものである。
  また、各関数は戻り値として正常終了なら次に遷移するべきモードの番号(0以上)を、それ以外(エラー等)なら負の数を返す。
  各関数は独立しており、関数が呼び出され終了するまでに、すべての必要な処理を終了している必要がある。
2. ライブラリ
  MIRS標準のモジュールを、統一されたインターフェースで使用できるようなラッパ関数を作成する。
  1. タッチセンサ
    - 機能
      タッチセンサの状態を管理する。
    - 構成要素
      - なし
    - 関数群
      1. int init_TS(void);
        
        引数
        なし
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. int get_TS(int num);
        
        引数
        num:取得するタッチセンサを指定する。
        戻り値
        numで指定した番号のタッチセンサの状態を返す。1なら押されている。0なら押されていない。データ読み込みを失敗したときには-1以下を返す。
      3. int *get_TS_all(int *data_array);
        
        引数
        int *data_array:このポインタが示すアドレスに、取得した配列データを書きこむ
        戻り値
        データ読み込みの成否を返す。0以下なら失敗、それ以外なら成功。
      4. int release_TS(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
  2. 超音波センサ
    - 機能
      超音波センサの状態を管理する。
    - 構成要素
      - MIRSATLM超音波センサモジュール
    - 関数群
      1. int init_USS(void);
        
        引数
        なし
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. double get_USS(int num);
        
        引数
        num:取得する超音波センサを指定する。
        戻り値
        numで指定した番号の超音波センサで、反応した物体までの距離をmm単位で返す。データ読み込みを失敗したときには-1以下を返す。
      3. int get_USS_all(double *data_array);
        
        引数
        double *data_array:このポインタが示すアドレスに、取得した配列データを書きこむ
        戻り値
        データ読み込みの成否を返す。0以下なら失敗、それ以外なら成功。
      4. int release_USS(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
  3. 赤外線センサ
    - 機能
      赤外線センサの状態を取得する。
    - 構成要素
      - MIRSATLM赤外線センサモジュール
    - 関数群
      1. int init_IRS(void);
        
        引数
        なし
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. int get_IRS(int num);
        
        引数
        num:取得する赤外線センサを指定する。
        戻り値
        numで指定した番号の赤外線センサが取得しているポストの番号を返す。0ならセンサの前に何もポストがない。読み込みに失敗したときには-1以下を返す。
      3. int get_IRS_all(int *data_array);
        
        引数
        int *data_array:このポインタが示すアドレスに、取得した配列データを書きこむ
        戻り値
        データ読み込みの成否を返す。0以下なら失敗、それ以外なら成功。
      4. int release_IRS(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
  4. PWM
    - 機能
      モータを制御し、指定した量だけMIRSを移動させる。
    - 構成要素
      - MIRSATLMPWMモジュール
    - 関数群
      1. int init_PWM(void);
        
        引数
        なし
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. int move_PWM(int x, int y, int velocity);
        
        引数
        x:x方向の移動量
        y:y方向の移動量
        velocity:移動速度
        
        戻り値
        移動の設定の成否を返す。0以下なら失敗、それ以外なら成功。
      3. int release_PWM(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
  5. LCD
    - 機能
      LCDに文字列を表示する。
    - 構成要素
      - MIRSATLMLCDデバイスドライバ
    - 関数群
      1. int init_LCD(void);
        
        引数
        なし
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. int print_LCD(char *string);
        
        引数
        string:表示するべき文字列
        戻り値
        表示の成否を表す。0以下なら失敗、それ以外なら成功。
      3. int release_LCD(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
  6. マウス
    - 機能
      マウスの移動量を取得する。
    - 構成要素
      - なし
    - 関数群
      1. int init_mouse(void);
        
        引数
        なし
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. int get_mouse_move(vector2 *position);
        
        引数
        position:現在の位置データを受け取るvector2構造体
        戻り値
        常に1
      3. int get_mouse_move_diff(vector2 *position);
        
        引数
        position:前回取得持からの差分データを受け取るvector2構造体
        戻り値
        常に1
      4. int release_mouse(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
  7. ログ
    - 機能
      ファイルに文字列を書き込む。
    - 構成要素
      - なし
    - 関数群
      1. int init_log(char *filefame);
        
        引数
        filename:ログのファイル名
        戻り値
        初期化の成否。0以下なら失敗、それ以外なら成功。
      2. int print_log(char *string);
        
        引数
        string:出力する文字列
        戻り値
        出力の成否。0以下なら失敗、それ以外なら成功。
      3. int release_log(void);
        
        引数
        なし
        戻り値
        解放の成否。0以下なら失敗、それ以外なら成功。
3. エラー処理
  1. 概要
    エラーの検出を行うためにエラー処理専用にスレッドを一つ作り、常にそのスレッドでエラーを監視する。
    エラーが起こった場合、モード処理関数からエラー処理関数のほうに全ての処理を移す。
    モードが遷移したときに、エラー処理スレッドに現在自分がどのモードにいるかを知らせなければならない。
    エラー処理スレッドが持つ現在のモードを表す値から、下の一覧のエラーからどの項目をチェックする必要があるかを判断する。
    エラー処理スレッドに、どのエラーチェックを有効にするかは、エラー一覧で定義されている値を組み合わせることで指定する。
    たとえば、ERR_EXTOUCHとERR_NO_IRをチェックしたい場合、処理判断用変数にERR_EXTOUCH | ERR_NO_IRを代入する。
  2. エラー内容
    1. ERR_EXTOUCH
      - 定義値
        0x00000001
      - 内容
        タッチセンサに、想定外の状態で反応があった。
      - 対処
        接触したポストの番号を取得し、現在の位置に補正をかける。
        その後、行動決定モードに処理を移す。
    2. ERR_POST_USS
      - 定義値
        0x00000010
      - 内容
        MIRSが移動中に発見したポストの位置が、過去に超音波センサを使って調べた位置と現在超音波センサで調べた位置で違った。
      - 対処
        今超音波センサで発見した値で、ポストの位置を上書きする。
        その後、行動決定モードに移行する。
    3. ERR_POST_TOUCH
      - 定義値
        0x00000100
      - 内容
        ポストに接触したときに、現在の位置と過去に調べたポストの位置とで差がある。
      - 対処
        現在の位置でポストの値を上書きする。
        その後処理をポスト周回モードに移す。
    4. ERR_NO_IR
      - 定義値
        0x00001000
      - 内容
        ポスト周回中にポストの赤外線信号を取得できなかった。
      - 対処
        再度ポストを周回し、赤外線信号を探す。
        信号を発見できたらポスト取得モードに移行し、できなかったらそのポストは取得したものとみなし、行動決定モードに移行する。
    5. ERR_FAILED_ET_IR
      - 定義値
        0x00010000
      - 内容
        ポスト取得時に、ポストに接触したにもかかわらず赤外線信号が消えない。
      - 対処
        再びポストから距離をとりポストを周回する。赤外線信号を見つけ次第、ポスト取得モードに移行する。
試験

MIRS0103は標準MIRSと構造が大きく異なるため、標準MIRSで行える試験は少ない。そのため、ソフトウェア以外の部分を早めに仕上げる必要がある。
ATLMで試験するモード、およびライブラリ
1. モード
  - 待機モード
  - ポスト数入力モード
  - 1回目競技用初期化モード
  - 2回目競技用初期化モード
  - 行動決定モード
  - ポストポスト中心割り出しモード
  - ポスト番号判断モード
  - 終了処理モード
2. ライブラリ
  - タッチセンサ
  - 超音波
  - 赤外線センサ
  - PWM
  - LCD
  - ログ
実機で試験するモード、およびライブラリ
1. モード
  - ポスト探索モード
  - 接近モード
  - ポスト取得モード
  - ポスト周回モード
2. ライブラリ
  - マウス

関連文書