太線で囲まれたモジュールは新規作成するもの、二重線で囲まれたモジュールは変更するものである。
| 名称 | MIRS1804 ソフトウェア詳細設計書 |
|---|---|
| 番号 | MIRS1804-SOFT-0001b |
| 版数 | 最終更新日 | 作成 | 承認 | 改訂記事 |
|---|---|---|---|---|
| B01 | 2019.02.12 | 米持春貴 中村美月 | 初版 |
ドキュメント内目次
本ドキュメントはMIRS1804 GYM員Projectのソフトウェア詳細設計書についてのドキュメントである。
| モジュール名 | 機能 | 関数名 | 引数 | 戻り値 |
|---|---|---|---|---|
| pilot(変更) | プログラム全体を制御する | main() | なし | なし |
| display(新規) | ディスプレイへ情報を送る ディスプレイから情報を受けとる |
display_send() display_waut() |
バッテリー残量(double)、走行終了判定(1or0) なし |
なし 走行モード(int) |
| run(新規) | 走行を制御する | run() | 走行モード(int) | なし |
| marker(新規) | マーカー設置用のモータの回転・停止を制御する | marker_set() | 回転速度(int) | なし |
| line(新規) | 石灰設置用のモータを回転させる 石灰設置用のモータを停止させる |
line_start() line_stop() |
回転速度(int) なし |
なし なし |
| request(変更) | マーカー設置信号をArduinoに送る 白線設置信号をArduinoに送る 弧走行信号をArduinoに送る |
request_set_marker request_set_line request_set_ark |
回転速度(int)、回転角度(int) 回転速度(int) 走行速度(int)、走行距離(int)、左右のタイヤの回転比(double) |
なし なし なし |
| モジュール名 | 機能 | 関数名 | 引数 | 戻り値 |
|---|---|---|---|---|
| slave | マーカー、白線、弧の走行機能を追加 | slave() | 変更なし | 変更なし |
| run_ctrl | 弧の走行機能を追加 弧の走行を制御する |
run_ctrl_execute() run_ctrl_set_ark() |
なし 走行速度(double)、走行距離(double)、左右のタイヤの回転比(double) |
なし なし |
| vel_ctrl | マーカー、弧の速度制御機能を追加 | vel_ctrl_execute() |
なし | なし |
| motor | マーカー、白線モーターの機能を追加 | motor_set_m() motor_set_line() |
pwm(int) pwm(int) |
| クラス名 | クラス概要 | モジュール名 | モジュール概要 | 引数 |
|---|---|---|---|---|
| StartFrame | 開始画面の表示 | __init__ | 表示フレームの設定 | parent,id |
| SetStartFrame | 画面表示 | - | ||
| OnTime | タイマーイベント(200msごと)発生時の処理 | event | ||
| ShowSelect | 選択画面への移行 | - | ||
| SelectFrame | 選択画面の表示 | __init__ | 表示フレームの設定 | parent |
| SetSelectFrame | 画面表示 | - | ||
| OnTime | タイマーイベント(200msごと)発生時の処理 | event | ||
| ChangeFigLeft | 左ボタン押下時の処理 | - | ||
| ChangeFigRight | 右ボタン押下時の処理 | - | ||
| SetFigure | 図面の変更 | - | ||
| ShowReady | 確認画面への移行 | - | ||
| ReadyFrame | 確認画面の表示 | __init__ | 表示フレームの設定 | parent |
| SetReadyFrame | 画面表示 | - | ||
| OnTime | タイマーイベント(200msごと)発生時の処理 | event | ||
| MoveLeft | カーソルを左に移動 | - | ||
| MoveRight | カーソルを右に移動 | - | ||
| ShowRun | 走行中画面への移行 | - | ||
| BackSelect | 選択画面へ戻る | - | ||
| RunFrame | 走行中画面の表示 | __init__ | 表示フレームの設定 | parent |
| SetRunFrame | 画面表示 | - | ||
| OnTime | タイマーイベント(1秒ごと)発生時の処理 | event | ||
| OnComm | 通信イベント発生時の処理 | event | ||
| ShowFinish | 完了画面への移行 | - | ||
| ShowEmergency | 緊急停止画面への移行 | - | ||
| FinishFrame | 完了画面の表示 | __init__ | 表示フレームの設定 | parent |
| SetFinishFrame | 画面表示 | - | ||
| OnTime | タイマーイベント(200msごと)発生時の処理 | event | ||
| ShowExit | 終了画面への移行 | - | ||
| ExitFrame | 終了画面の表示 | __init__ | 表示フレームの設定 | parent |
| SetExitFrame | 画面表示 | - | ||
| ExitApp | アプリケーション全体の終了 | event | ||
| Emergency | 緊急停止画面の表示 | __init__ | 表示フレームの設定 | parent |
| SetEmergency | 画面表示 | - |
| クラス名 | クラス概要 | モジュール名 | モジュール概要 | 引数 | 戻り値 |
|---|---|---|---|---|---|
| CommEvent | 通信イベントの設定 | __init__ | 通信イベントの設定 | self,flag | - |
| CommunicationThread | 通信スレッド | __init__ | スレッドの設定 | self,window | - |
| run | 走行プログラムからの受信 | self | - | ||
| - | - | GetData | 日時の取得 | - | 日時 |
| - | - | FigSet | 表示する図面の取得 | - | 図面の画像 |
| - | - | CountRight | 図面番号を1,2,3,4,1,…の順に変化させる | - | - |
| - | - | CountLeft | 図面番号を1,4,3,2,1,…の順に変化させる | - | - |
| - | - | GetCount | 現在の図面番号を返す | - | 図面番号 |
| - | - | CommSend | 走行プログラムに図面番号を送信する | - | - |
| - | - | RunAnimation | アニメーションの表示処理 | - | アニメーションの画像 |
| - | - | CountUp | アニメーションのカウントを増やす | - | - |
| - | - | GPIOStart | GPIOの設定 | - | - |
| - | - | GPIOExit | GPIOポートの終了処理 | - | - |
| 使用ポート | 送信側 | 受信側 | 送信データ(型) |
|---|---|---|---|
| 51000 | アプリケーション | 走行プログラム | 図面番号(int) |
| 51001 | 走行プログラム | アプリケーション | 走行完了情報(char) |
テスト項目を以下に示す。
・C言語の関数、変数について
関数は全て小文字の短い名前で書き、2単語以上の場合は単語の区切りにアンダーバー「＿」を入れる。
変数は全て小文字の短い名前で書き、2単語以上の場合は2単語目以降の単語の頭文字を大文字にする。
・バージョン管理について
新しい機能を追加した際にそのバージョンのバックアップを取り、バージョンの数字を上げていく。
バージョンを上げた際には、足した機能をテキストファイルにまとめる。