Changes
fd_DXSetPIDGain 
¶
fd_fd_DXSetPIDGain
指定IDのアクチュエータに対して、位置決め制御時のゲインを設定する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetPIDGain (uint8_t id, uint8_t PGain, uint8_t IGain, uint8_t DGain);
- uint8_t id
0～253: 対象デバイスのID
- uint8_t PGain
0～254: Pゲイン
- uint8_t IGain
0～254: Iゲイン
- uint8_t DGain
0～254: Dゲイン
- 戻り値
true: 成功
false: 失敗
¶
¶
¶
関数内で動的に確保できるメモリのサイズはToppersのライブラリ(aspcore.h内に宣言がある)によって2kバイトに制限されています。これは変数の宣言も含まれ、本ライブラリで定義される型等はサイズが大きいため、不用意に宣言(記憶域をautoで指定)してしまうと気づかないうちにスタックフローが生じ、プログラムの動作に支障をきたします。
関数内でサイズの大きい変数を確保する場合はstatic指定子を付与し、静的にメモリを確保させる事でこの制限を回避する事ができます。
概要
FREEDOM IIIライブラリVer.4は、FDIII-HCとDynamixelシリーズで構成されたアプリケーションを効率的に運用するためのライブラリです。
アクチュエータのIDやアクチュエータの位置を角度に変換するパラメータを元に、各アクチュエータを連動して動かしたり、アクチュエータの持つ情報を取得するといったアプリケーションレベルにおいて最低限必要な機能を本ライブラリでカバーします。
なお、本ライブラリはその外のライブラリ(SAM7S, SAM7S_TOPPERS等)を静的に使用していますので、ベンダーから提供されるGCC Developer Liteをインストールする際は、各コンポーネントを手動で選択することなくフルインストールした環境で使用して下さい。また、全てのソースもインストールと同時に展開されますので、必要に応じて参照できます。
本ライブラリで提供されるAPIのプロトタイプ宣言や特殊な構造体はfd.hに集約されています。このヘッダファイルに宣言が無いAPIは使用しないで下さい。
API
機能別にAPIの詳細を解説します。主なコンテンツを以下に紹介します。
- OS関連
Toppersに関連する機能やFREEDOM III libraryのエンジン部分を担うAPI。
- サウンド
FDIII-HCに搭載されたブザーによる音楽の演奏API。
- コンソール
USBやBluetoothを介したコンソールAPI。
- LCD描画
FDIII-HCに接続して使用するLCDの描画API。
- RC-100B
BluetoothによるリモートコントローラRC-100Bとの通信API。
- SIXAXIS
BluetoothによるリモートコントローラSIXAXISないしDUALSHOCK3との通信API。
- ホームポジション・モーションファイル管理
FREEDOM III libraryで扱う主要なデータをSDカードで扱うAPI。
- Dynamixelプロトコル
Dynamixelプロトコルをサポートするデバイスとコミュニケーションを行うAPI。
- Dynamixelアクチュエータシリーズ専用
Dynamixelプロトコルをサポートするアクチュエータ専用のコミュニケーションAPI。
- SDファイルアクセス
任意のデータをSDカードを介して扱うAPI。
- FREEDOM IIIライブラリ専用型定義
FREEDOM III library全般で使用されるオリジナルな変数宣言。
旧来に比べかなりのボリュームになっていますが、実際には全てを使うわけではありません。必要に応じてAPIを使用してユーザアプリケーションを構成します。まずはFDIII-HCのサンプルプログラムを一通り実行して、動作を確認する事を推奨します。
OS関連
FREEDOM IIIライブラリはToppersに依存しており、予め予約されたリソースのうちユーザに解放しているものであれば自由に使用できます。主な恩恵は複数のタスクが使用できることにあります。
各タスクで利用できるスタックはカーネルのコンフィギュレーションで2kバイトに固定されています。大きなメモリを必要とする処理(変数の宣言やネストが深い関数の呼び出し)を行うと容易にスタックがフローします。
TASK5はライブラリ内で使用済みとなりますので、ユーザプログラムから制御してはなりません。その他のリソースについてもライブラリ内で使用済みなものがいつくか存在しますので、詳細はライブラリのソースにて確認してください。
なお、ToppersのAPIに関してはここでは触れませんので、具体的な使い方等についてはサンプルプログラムで確認してください。
fd_ElapsedTime
起動からの経過時間を1ms単位で取得する。
uint32_t fd_ElapsedTime (void);
- パラメータ
なし
- 戻り値
0～: 経過時間[ms]
- 使用例
#include <fd.h>
int main (void) {
while (!fd_rx_buff ()) {
int ms = fd_ElapsedTime ();
int s = (ms / 1000) % 60;
int m = (ms / 60000) % 60;
int h = (ms / 360000) % 24;
fd_printf ("r %02d:%02d:%02d.%02d", h, m, s, (ms % 1000) / 10);
fd_Wait (10);
}
}
fd_Wait
タスク起床待ち状態に移行させる。内部ではtslp_tskに置き換えられるため、tslp_tskをそのまま使っても同等の処理となる。
なお、プリエンプティブ・マルチタスクを活性化する機能(fd_EnableAutoRotateReadyQueue)はデフォルトでONとなっているため、本APIを時間がかかる処理やループ内に適宜挿入して意図的にディスパッチを促す必要はないが、OFFの場合は他のタスク(ライブラリで使用しているTASK5も含む)の期待する動作が阻害される場合がある。
fd_SoftReset
実行中のアプリケーションプログラムを強制終了し、ブートローダへ移行する。なお、mainから抜けると同様の処理が行われる。
void fd_SoftReset (void);
fd_GetShutdownState
fd_SoftResetないしmainからリターンした事による終了を検出する。
bool fd_GetShutdownState (void);
fd_EnableAutoRotateReadyQueue
1ms単位で励起されるレディーキューの強制自動回転を許可する。許可されるとプリエンプティブ・マルチタスクなOSとして利用できる。
void fd_EnableAutoRotateReadyQueue (bool en);
main
mainタスクから呼ばれるユーザ用に解放されたコールバック関数。mainタスクでライブラリ内で必要となる最低限の初期化処理が行われた後、本main関数が呼ばれる。main関数の宣言が無いと即時終了するプログラムとなる。
USER_TASK1
TASK1から呼ばれるユーザ用関数。実質TASK1として扱って構わない。
USER_TASK2
TASK2から呼ばれるユーザ用関数。実質TASK2として扱って構わない。
USER_TASK3
TASK3から呼ばれるユーザ用関数。実質TASK3として扱って構わない。
USER_TASK4
TASK4から呼ばれるユーザ用関数。実質TASK4として扱って構わない。
- 使用例
#include <fd.h>
void USER_TASK4 (void) {
int c;
while (!fd_GetShutdownState ()) {
rcv_dtq (DTQ1, (VP_INT*)&c);
fd_putc (c);
if (c == '33') break;
}
fd_SoftReset ();
}
void main (void) {
char c;
act_tsk (TASK4);
fd_puts ("nSMPL3 STARTn");
while (!fd_GetShutdownState ()) {
if (fd_rx_buff ()) {
while (fd_rx_buff ()) {
c = fd_getc ();
snd_dtq (DTQ1, c);
}
}
fd_Wait (10);
}
}
システム共通
本ライブラリを使用するにあって必須の初期化処理、各種パラメータの設定、モーションの実行等を行うAPIです。
fd_SetSpec
モーションの再生等に使用されるホームポジション値及びネットワークに接続されるデバイスの諸元(ID・動作範囲・各種リミッタ等)の設定を行う。本API を実行しなければモーション等は再生できない。
fd_GetInitalizedSpecにてパラメータの初期化が既に行われているかの判断ができる。
なお、諸元データ内にアクチュエータのパラメータが記述されておりfd_SetUVThresholdで指定された電圧を超えていれば、本APIにて各アクチュエータと通信を行い、それらパラメータの設定が行われる。また、それに伴いアクチュエータの出力軸が現在の位置にロックされる。
void fd_SetSpec (const PHomePosition hp, const TSpec *svp, int size);
- パラメータ
- const PHomePosition hp
ホームポジションを保持したTHomePosition構造体の変数のアドレス
ホームポジションは全ての動作の基準となるアクチュエータの初期位置(0～1023 の値)であり角度ではない
- const TSpec *svp
使用する全アクチュエータに関する情報を保持したTSpec構造体の変数のアドレス
- int size
psvで指定したTSpecの配列の個数
fd_SpecSizeマクロを使用すると簡便に算出できる
- 戻り値
なし
- 使用例
#include <fd.h>
// 諸元
const TSpec Spec[] = {
// id device offset gain min max speed trq. comp.
{ 1, DEV_RX28, fd_AxisOfs(0), +341, { 0, 1023}, 0, 1023, { 1, 1, 32, 32} },
{ 2, DEV_RX28, fd_AxisOfs(1), +341, { 0, 1023}, 0, 1023, { 1, 1, 32, 32} },
{ 3, DEV_RX28, fd_AxisOfs(2), +331, { 0, 1023}, 0, 1023, { 1, 1, 32, 32} },
};
// ホームポジションデータ
THomePosition HomePosition = { 512, 512, 512};
void main (void) {
fd_SetSpec (&HomePosition, Spec, fd_SpecSize (Spec));
}
fd_GetInitalizedSpec
fd_SetSpecによって必要な初期化がなされているかの状態を取得する。
bool fd_GetInitalizedSpec (void);
fd_SetHomePosition
ホームポジションを再設定する。
void fd_SetHomePosition (const PHomePosition hp);
fd_SetBeepCondition
ビープを発音する条件をORで設定する。デフォルトでは各条件が発生しても無音となる。
void fd_SetBeepCondition (uint8_t beep);
fd_SetUVThreshold
FDIII-HCに印加される電源の電圧低下を検出する際の閾値を設定する。電圧低下を検出するとfd_SetBeepConditionにてFD_BEEP_LOWVOLTAGEが指定されている際にアラーム音が発生する他、デバイスとの通信を伴う一部のAPIが実際の処理を行わずに呼び出し元に戻る。
void fd_SetUVThreshold (float PilotVoltage);
- パラメータ
- float PilotVoltage
電圧[V]を実数で指定
デフォルトは0
- 戻り値
なし
fd_GetPresentVoltage
FDIII-HCに供給されている電源の電圧を取得する。
uint32_t fd_GetPresentVoltage (void);
fd_SetLed
FDIII-HCに搭載されたLED2(橙色)を点灯・消灯する。
void fd_SetLed (bool On);
fd_GetPB
FDIII-HCに搭載されたプッシュボタン(PB1)の状態を取得する。
- パラメータ
なし
- 戻り値
true: DOWN
false: UP
fd_GetDIP
FDIII-HCに搭載されたディップスイッチ(DIP1)の状態を取得する。
uint8_t fd_GetDIP (void);
fd_GetAcceleration
FDIII-HCに搭載された3軸加速度センサの値を取得する。
なお、取得する値には個体差が含まれるため、使用状況に応じて適宜補正する事を推奨する。
void fd_GetAcceleration (uint16_t *v);
- パラメータ
- 戻り値
なし
- 使用例
#include <fd.h>
void main (void) {
uint16_t acc[3];
while (!fd_rx_buff ()) {
fd_GetAcceleration (acc);
fd_printf ("r %3d %3d %3d33[K", acc[0], acc[1], acc[2]);
fd_Wait (100);
}
}
fd_ExtractMaxAngleDiffByDeg
現在の相対角度と指定ポーズの最大角度差を抽出する。
int fd_ExtractMaxAngleDiffByDeg (const PPose Pose, PApplyPart pap);
- パラメータ
- 戻り値
角度(deg)の10倍値
- 使用例
#include <fd.h>
// 諸元
TSpec Spec[] = {{ 1, DEV_RX28, fd_AxisOfs(0), +341, { 0, 1023}, 0, 1023, { 1, 1, 32, 32} },};
// 適用部位
TApplyPart mypart = { Priority: 1, PartNum: 1, Part:{ fd_AxisOfs(0), }};
// ホームポジション
THomePosition HomePosition = { 512 };
// ホームポジションへ移行するモーション
TPose GoHome[] = { { Structure: { 0}, ADJ_SACC_SDECEL, Div:1000 }};
void main (void) {
int Maxdiff;
DX_ChangeBaudrate (1000000);
// 諸元設定
fd_SetSpec (&HomePosition, Spec, fd_SpecSize (Spec));
// 目標角度との差を抽出
Maxdiff = fd_ExtractMaxAngleDiffByDeg (GoHome, &mypart);
// 差を適当に時間換算
GoHome[0].Div = Maxdiff * 2;
// モーションの再生
if (fd_PlayMotion (GoHome, 1, fd_MSize (GoHome), 100, &mypart)) {
// 再生中なら待つ
while (fd_GetMotionStat (&mypart) && !fd_rx_buff ()) fd_Wait (10);
}
// モーション再生を停止
fd_StopMotion (&mypart);
}
fd_PlayMotion
複数のポーズで構成されたモーションを指定された部位で再生し、即時復帰する。モーションは紙芝居を動きのあるアニメーション化するのと似ており、ポーズ間をスムーズにつなぐ処理を自動的に行う。また最初のポーズへ移行する際は現在の姿勢が基準となる。
実際のポーズ間の補間は指定される遷移時間内に数ms程度の間隔で位置の指令を小刻みに行う事で実現しているため、その周期で若干のトルクリプルが生じる場合がある。また、指令にはSYNCインストラクションを使用しており、アクチュエータへ指令が確実に伝わったかどうかの判定は行っていない。
なお、予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、その間の補間データの送信は行われない。
bool fd_PlayMotion (PPose Motion, short StartPoint, short EndPoint, uint16_t Speed, PApplyPart ApplyPart);
fd_StopMotion
指定部位でモーションが再生中であれば、現在位置で中断させる。何らかの要因で停止が検出できない場合でも、最低1秒間は停止処理を行う。
bool fd_StopMotion (const PApplyPart pap);
fd_GetMotionStat
指定部位でモーションが再生中かを取得する。
bool fd_GetMotionStat (const PApplyPart pap);
- パラメータ
- 戻り値
true: 再生中
false: 停止中
fd_SendMomentMotion
1つのポーズを指定された部位で再生し、即時復帰する。fd_PlayMotionとの違いは補間制御を全く行わない事にあり、設定された角度を直接指令する。また、補間方式や遷移時間が必要ないため、TPoseではなくTStructureで指定する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、その間のデータ送信は行われない。
bool fd_SendMomentMotion (const PStructure sv, PApplyPart pap);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_AssistMotionEdit
軸の角度を都度取得して一連のモーションを作成手法(ティーチング)が採られるケースがある。本APIではモーションデータを動的に作成する場合に、それらの一部の機能を補助する。
実際には他のAPIを併用した上で、モーションエディタとしてプログラムを構成する必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、通信にかかる一部機能が正常に完了しない。
bool fd_AssistMotionEdit (TEdCmd cmd, int *pos, int *page, PPose Pose, PApplyPart pap);
- パラメータ
- TEdCmd cmd
実行する処理
- int *pos
0: 空
1～20: 現在対象としているポーズ位置
- int *page
0: 空
1～20: キャプチャないし指定されたポーズ数(配列要素数)
- PPose Pose
作成するモーションデータが保存されたTPose構造体の変数のアドレス
サポートするポーズ数は最大20
- PApplyPart pap
対象の部位を指定したTApplyPart構造体の変数のアドレス
- 戻り値
true: 成功
false: 失敗
fd_ConvDeg2Pos
TStructureに設定されたホームポジションからの相対角度を絶対位置に変換する。fd_ConvPos2Degの逆。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
bool fd_ConvDeg2Pos (PStructure deg, PStructure pos, PApplyPart pap, bool limit);
- パラメータ
- PStructure deg
変換元の角度を保存したTStructure構造体の変数のアドレス
- PStructure pos
変換先のTStructure構造体の変数のアドレス
- PApplyPart pap
変換対象の部位を指定したTApplyPart構造体の変数のアドレス
- bool limit
true: 変換後の位置情報をTSpec内のTOpRangeで指定された動作範囲内に収める
false: 変換後の位置情報をそのまま適用する
- 戻り値
true: 成功
false: 失敗
fd_ConvPos2Deg
TStructureに設定された絶対位置をホームポジションからの相対角度に変換する。fd_ConvDeg2Posの逆。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
bool fd_ConvPos2Deg (PStructure pos, PStructure deg, PApplyPart pap);
- パラメータ
- PStructure pos
変換元の位置を保存したTStructure構造体の変数のアドレス
- PStructure deg
変換先のTStructure構造体の変数のアドレス
- PApplyPart pap
変換対象の部位を指定したTApplyPart構造体の変数のアドレス
- 戻り値
true: 成功
false: 失敗
fd_GetIDbyOffset
オフセットアドレスからTSpecに記述されたIDを抽出する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
int fd_GetIDbyOffset (short *ofs);
fd_GetSpecIndexbyOffset
オフセットアドレスからTSpecの配列要素のインデックスを抽出する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
int fd_GetSpecIndexbyOffset (short *ofs);
fd_CheckDXAlarmState
TSpecで定義されたネットワークに接続される全デバイスのステータスをチェックする。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
bool fd_CheckDXAlarmState (PAlarmStatus stat, int *num);
- パラメータ
- PAlarmStatus stat
TAlarmStatusの配列のアドレス
- int *num
statの配列数
- 戻り値
true: 成功
false: 失敗
fd_LockDXParam
指定された部位のアクチュエータのみに対して、EEPROMエリアの書き換え禁止を指令する。一度書き換え禁止を行うと、アクチュエータを再起動しない限りEEPROMエリアの書き換えは行えない。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_LockDXParam (PApplyPart pap);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_SetDXEnableControl
指定された部位のアクチュエータのみに対して、位置決め制御の開始・停止を指令する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_SetDXEnableControl (bool en, PApplyPart pap);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_SetDXTorqueLimit
指定された部位のアクチュエータのみに対して、トルクリミッタの制限値を設定する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_SetDXTorqueLimit (uint16_t t, PApplyPart pap);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_GetDXCurrentAngleByPos
指定された部位の現在の絶対位置を取得する。ホームポジションからの相対角度で取得する場合はfd_GetDXCurrentAngleByDegを使用する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_GetDXCurrentAngleByPos (PStructure angle, PApplyPart pap);
- パラメータ
- 戻り値
true: 成功
false: 失敗
- 使用例
#include <fd.h>
// 諸元
const TSpec Spec[] = {
// id device offset gain min max
{ 1, DEV_RX28, fd_AxisOfs(0), +341, { 0, 1023}},
{ 2, DEV_RX28, fd_AxisOfs(1), +341, { 0, 1023}},
};
// 適用部位
TApplyPart mypart = {
Priority: 1,
PartNum: 2,
Part:{
fd_AxisOfs(0),
fd_AxisOfs(1),
}
};
// ホームポジション
THomePosition hp = { 512, 512};
void main (void) {
DX_ChangeBaudrate (1000000);
fd_SetSpec (&hp, Spec, fd_SpecSize (Spec));
// 現在位置を取得しその値でホームポジションを更新
if (fd_GetDXCurrentAngleByPos (&hp, &mypart)) fd_SetHomePosition (&hp);
}
fd_GetDXCurrentAngleByDeg
指定された部位のホームポジションからの相対角度を取得する。絶対位置で取得する場合はfd_GetDXCurrentAngleByPosを使用する。
予めfd_SetSpecでホームポジションと使用するアクチュエータの情報を設定しておく必要がある。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_GetDXCurrentAngleByDeg (PStructure angle, PApplyPart pap);
- パラメータ
- 戻り値
true: 成功
false: 失敗
サウンド
FDIII-HCのブザーを使用して任意の音階の発音やメロディーを奏でることが出来ます。
なお、再生中であってもfd_SetBeepConditionで設定された条件が優先されて、再生が中断する場合があります。
fd_PlayMusic
独自のMML(Music Macro Language)もどきで譜面ライクに音楽を記述し、再生させ即時復帰する。再生がMMLの最終命令を経過すると再生終了となる。
void fd_PlayMusic (bool force, const char *MML);
fd_GetMusicStat
MMLが再生されているかを取得する。
bool fd_GetMusicStat (void);
- パラメータ
なし
- 戻り値
ture: 再生中
false: 停止中
fd_ToneOn
指定の音階を連続的に発音する。MMLが再生中の場合は無視される。
void fd_ToneOn (int Oct, int Tone);
fd_ToneOff
fd_ToneOnにより発音中であれば停止する。
コンソール
FDIII-HCでは主にUSBを介したシリアル通信を使用してプログラムの転送や実行中のプログラムのモニタ等を行うため、簡便に文字や文字列の送受信を行うためのAPIを用意しています。USBの他にBluetoothのSPP及びDBGU(TTLレベル)によるシリアル通信も使用できます。
なお、コンソールAPIでは各コンソール系I/Fを個別に取り扱う事ができません。
fd_AssignUARTToConsole
FDIII-HCのCN14をコンソールとして初期化する。FDIII-DISPLAYを接続した際は、115200bpsを指定して初期化する。
なお、指定されたボーレートと実際にライブラリ内で適用されるボーレートは誤差が生じるので、戻り値を確認して使用可能なボーレートであるかを判断する必要がある。
また、内部の送受信バッファは各々100バイトである。
uint32_t fd_AssignUARTToConsole (uint32_t dbgu_baud);
- パラメータ
- uint32_t dbgu_baud
ボーレート[bps]
- 戻り値
0: 失敗
1～: 近似された実ボーレート
fd_DeassignUART
UARTに割り当てた機能を無効化する。
void fd_DeassignUART (void);
fd_AssignBTToConsole
FDIII-HCのBluetoothをコンソールとして初期化する。
なお、Bluetoothの動作自体はFDIII-HCのブートローダで設定されたBluetoothの接続モードに依存する。
また、内部の送受信バッファは各々200バイトである。
void fd_AssignBTToConsole (void);
fd_DeassignBT
Bluetoothに割り当てた機能(コンソール・SIXAXIS・RC-100B)を無効化する。
void fd_DeassignBT (void);
fd_rx_buff
受信バッファにあるデータ数を取得する。受信バッファからデータを取り出すにはfd_getcを使用する。
なお、複数のI/Fをコンソールとしてアサインしている場合は、最後に入力があったI/Fの受信バッファに保存されているデータ数となる。
- パラメータ
なし
- 戻り値
バッファに保存された受信データのバイト数
- 使用例
#include <fd.h>
void main (void) {
int i, n = 0;
char c, s[20];
// DBGUをコンソールに
fd_AssignUARTToConsole (115200);
// Bluetoothをコンソールに
fd_AssignBTToConsole ();
// PB1が押されるまでループ
while (!fd_GetPB ()) {
// 受信バッファにデータがあるまでループ
while (fd_rx_buff ()) {
// 1バイト取り出して送信
fd_putc (c = fd_getc ());
switch (c) {
// 文字列送信
case '0': fd_puts ("nHELLO!n"); break;
// 書式付文字列送信
case '1': fd_printf ("nn++=%dn", n++); break;
// 文字列受信
case '2': fd_puts ("ns<-"); fd_gets (s, 19); fd_puts ("n"); fd_puts (s); break;
// 書式付文字列入力
case '3': fd_puts ("ni<-"); fd_scanf ("%d", &i); fd_printf ("nd=%dn", i); break;
}
}
fd_Wait (10);
}
}
fd_rx_purge
受信バッファにあるデータを消去する。
fd_putc
指定された1バイトのデータを送信する。
void fd_putc (const char c);
fd_getc
受信バッファから1バイト取得する。受信バッファが空の場合は1バイト受信するまで返らない。
- パラメータ
なし
- 戻り値
受信バッファに保存された一番古い1バイトのデータ
fd_puts
指定された文字列を送信する。
void fd_puts (const char *s);
- パラメータ
- const char *s
送信文する字列のアドレス
- 戻り値
なし
fd_gets
指定された文字数以下の文字列を指定バッファに受信する。改行でそれ以前に入力された文字列を指定バッファにコピーし入力文字数を返す。エスケープで処理をキャンセルし0を返す。
バイナリデータの受信には使用できない。
int fd_gets (char *s, int len);
- パラメータ
- char *s
受信した文字列を保存するバッファのアドレス
- int len
最大受信文字数
- 戻り値
受信した文字のバイト数
fd_printf
指定された書式付きの文字列を送信する。
int fd_printf (const char *, ...);
fd_scanf
書式付入力を行う。コンソールからの入力を、指定された書式に従って変数へ読み込む。
int fd_scanf (const char * fmt, ...);
fd_cls
コンソールとして使用しているターミナル上のテキストを全消去する。
fd_locate
コンソールとして使用しているターミナル上のカーソル座標を指定する。
SIMPLE TERMとLCDの座標系が異なるため、直接エスケープシーケンスで座標を指定せずに本APIで代用する事を推奨する。
void fd_locate (int x, int y);
- パラメータ
- int x
1～80: 画面左上を1としたX座標
- int y
1～24: 画面左上を1としたY座標
- 戻り値
なし
LCD描画
オプションのLCDを対象としたAPIで、主にグラフィックの描画を行います。
解像度は内部固定で、左上が(0,0)、右下が(319,239)の座標を持ちます。基本的にこの座標の範囲外の値を指定した場合は描画処理を行いません。
fd_LCDExists
LCDが接続されているかを検出する。検出に成功した場合でも、処理に少なくとも数十msかかる。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
bool fd_LCDExists (void);
- パラメータ
なし
- 戻り値
true: 検出成功
false: 検出失敗
fd_LCDSetFontSize
LCDのテキストプレーンの解像度を変更する。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDSetFontSize (uint8_t sz);
fd_LCDSelectPictureBuff
LCDに備わった4枚のグラフィックバッファのうち、指定されたバッファを表示する。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDSelectPictureBuff (uint8_t plane);
- パラメータ
- uint8_t plane
0～3: バッファ番号
- 戻り値
なし
fd_LCDSetBGColor
LCDの指定されたグラフィックバッファを表示対象とし、背景色を設定する。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDSetBGColor (TColor color, uint8_t plane);
- パラメータ
- TColor color
背景色
- uint8_t plane
0～3: バッファ番号
- 戻り値
なし
fd_LCDDrawPixel
指定された座標のドットをLCDに描画する。
LCDモジュールのファームウェアに依存し、初期バージョンのファームウェアでは描画されない。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDDrawPixel (uint16_t X, uint16_t Y, TColor color, uint8_t plane);
- パラメータ
- uint16_t X
0～319: X座標
- uint16_t Y
0～239: Y座標
- TColor (*func)(int x, int y)
指定座標の色を返すコールバック関数のアドレス
- uint8_t plane
0～3: バッファ番号
- 戻り値
なし
fd_LCDDrawLine
指定された(X0,Y0)と(X1,Y1)の座標を結ぶ直線をLCDに描画する。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDDrawLine (uint16_t X0, uint16_t Y0, uint16_t X1, uint16_t Y1, TColor color, uint8_t plane);
- パラメータ
- uint16_t X0
0～319: 始点のX座標
- uint16_t Y0
0～239: 始点のY座標
- uint16_t X1
0～319: 終点のX座標
- uint16_t Y1
0～239: 終点のY座標
- TColor color
色
- uint8_t plane
0～3: バッファ番号
- 戻り値
なし
fd_LCDDrawSquare
指定された(X0,Y0)と(X1,Y1)の座標を対角に持つ矩形をLCDに描画する。
LCDモジュールのファームウェアに依存し、初期バージョンのファームウェアでは「塗りつぶしなし」が描画されない。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDDrawSquare (uint16_t X0, uint16_t Y0, uint16_t X1, uint16_t Y1, bool fill, TColor color, uint8_t plane);
fd_LCDDrawElipse
指定された(X,Y)を中心とした楕円をLCDに描画する。
LCDモジュールのファームウェアに依存し、初期バージョンのファームウェアでは描画されない。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
void fd_LCDDrawElipse (uint16_t X, uint16_t Y, uint16_t hRadius, uint16_t vRadiuse, bool fill, TColor color, uint8_t plane);
fd_LCDDrawPicture
指定された矩形領域に任意の画像をLCDに描画する。ピクセル単位で描画を行うため、処理に時間を要する。
予めfd_AssignUARTToConsoleを使用してCN14を115200[bps]の通信速度で初期化しておく必要がある。
bool fd_LCDDrawPicture (uint16_t X, uint16_t Y, uint16_t width, uint16_t height, TColor (*func)(int x, int y), uint8_t plane);
- パラメータ
- 戻り値
true: 描画処理対象
false: 描画処理対象外
- 使用例
#include <fd.h>
#include <math.h>
const TColor
black = {R: 0, G: 0, B: 0},
yellow = {R:31, G:31, B: 0};
void elipse (uint16_t X, uint16_t Y, uint16_t hRadius, uint16_t vRadius, TColor color, uint8_t plane) {
int hDia = hRadius << 1, vDia = vRadius << 1;
TColor mydraw (int x, int y) {
if (fd_GetShutdownState ()) return (TColor)(uint16_t)0xffff;
if (x < hRadius && y < vRadius) {
if (y < vRadius + sqrt (pow (vRadius, 2.0) - pow ((x - hRadius), 2.0) * pow (vRadius, 2.0) / pow (hRadius, 2.0)) && x < hRadius - sqrt (pow (hRadius, 2.0) - pow ((y - vRadius), 2.0) * pow (hRadius, 2.0) / pow (vRadius, 2.0))) return (TColor){t:1};
else return color;
} else {
if (y < vRadius + sqrt (pow (vRadius, 2.0) - pow ((x - hRadius), 2.0) * pow (vRadius, 2.0) / pow (hRadius, 2.0)) && x < hRadius + sqrt (pow (hRadius, 2.0) - pow ((y - vRadius), 2.0) * pow (hRadius, 2.0) / pow (vRadius, 2.0))) return color;
else return (TColor){t:1};
}
}
if ((plane > 3) || (hDia <= 0) || (vDia <= 0)) return;
fd_LCDDrawPicture (X - hRadius, Y - vRadius, hDia, vDia, &mydraw, plane);
}
void main (void) {
fd_AssignUARTToConsole (115200);
fd_LCDSelectPictureBuff (0);
fd_LCDSetBGColor (black, 0);
elipse (160, 120, 100, 100, yellow, 0);
}
RC-100B
FDIII-HCとRC-100B(FREEDOM Jr.III Wireless Controller)をBluetoothで接続し、使い慣れたゲーム用ジョイスティックライクなコントローラを利用した簡易的な操縦系や、FDIII-HCでは不足している外部からの入力系の補助としてとして使用できます。
なお、予めFDIII-HCのブートローダでBluetoothをSLAVEモードにし、RC-100Bとペアリングしておく必要があります。
fd_AssignBTToRC100
BluetoothをRC-100Bとの接続専用に初期化する。以下に示すRC-100B用APIを使用する前に1度だけ実行する必要がある。
以後RC-100B用API以外の使用目的(コンソールやSIXAXIS)でBluetoothを利用する事はできない。
uint32_t fd_AssignBTToRC100 (void);
fd_ClearRC100Buff
受信バッファをクリアする。
void fd_ClearRC100Buff (void);
fd_GetRC100Buff
受信バッファにあるデータ数を取得する。RC-100Bに備わったボタンの状態が変化すると、その都度バッファにその状態が蓄えられる。
uint16_t fd_GetRC100Buff (void);
fd_GetRC100Data
受信バッファから最も古い1データを取得する。受信バッファが空の場合はボタンの変化があるまで返らない。
void fd_GetRC100Data (Prc100Stat c);
fd_GetRC100Current
受信バッファから最新の1データを取得する。受信待ちは行わない。
void fd_GetRC100Current (Prc100Stat c);
SIXAXIS
FDIII-HCのBluetoothにはPlayStation®3用のワイヤレスコントローラであるSIXAXISないしDUALSHOCK®3との接続機能が備わっています。RC-100Bにはないアナログスティックや加速度センサが内蔵されており、それらの信号も取り込むことが可能です。
使い慣れたゲーム用コントローラを利用した簡易的な操縦系や、FDIII-HCでは不足している外部からの入力系の補助としてとして使用してください。
なお、予めFDIII-HCのブートローダでBluetoothをSIXAXISモードにし、更にSIXAXIS自体にFDIII-HCのMACアドレスを登録しておく必要があります。
fd_AssignBTToSIXAXIS
BluetoothをSIXAXISないしDUALSHOCK3との接続専用に初期化する。以下に示すSIXAXIS用APIを使用する前に1度だけ実行する必要がある。
以後SIXAXIS用API以外の使用目的(コンソールやRC-100B)でBluetoothを利用する事はできない。
uint32_t fd_AssignBTToSIXAXIS (void);
- パラメータ
なし
- 戻り値
端末速度[bps]
- 使用例
#include <fd.h>
void main (void) {
// ボタンデータの取得用変数の定義
static TsixaxisStat rc;
// BluetoothをSIXAXISの受信に使用
fd_AssignBTToSIXAXIS ();
// コンソールの入力がない間ループ
while (!fd_rx_buff ()) {
// SIXAXISの受信バッファがある間ループ
while (fd_GetSIXAXISBuff ()) {
fd_GetSIXAXISData (&rc);
fd_printf (
"x1b[1;1%d %d %d %d33[Kn",
rc[_SIXAXIS_BTN_U].down,
rc[_SIXAXIS_BTN_D].down,
rc[_SIXAXIS_BTN_L].down,
rc[_SIXAXIS_BTN_R].down
);
}
// アナログ値の取得
fd_printf (
"x1b[2;1H %4d %4d %4d %4d33[K",
fd_GetSIXAXISAnalog (_SIXAXIS_ANA_LANAH),
fd_GetSIXAXISAnalog (_SIXAXIS_ANA_LANAV),
fd_GetSIXAXISAnalog (_SIXAXIS_ANA_RANAH),
fd_GetSIXAXISAnalog (_SIXAXIS_ANA_RANAV)
);
fd_Wait(50);
}
}
fd_ClearSIXAXISBuff
受信バッファをクリアする。
void fd_ClearSIXAXISBuff (void);
fd_GetSIXAXISBuff
受信バッファにあるデータ数を取得する。SIXAXISに備わったボタンの状態が変化すると、その都度バッファにその状態が蓄えられる。
uint16_t fd_GetSIXAXISBuff (void);
fd_GetSIXAXISData
受信バッファから最も古い1データを取得する。受信バッファが空の場合はボタンの変化があるまで返らない。
void fd_GetSIXAXISData (PsixaxisStat c);
fd_GetSIXAXISCurrent
受信バッファから最新の1データを取得する。受信待ちは行わない。
void fd_GetSIXAXISCurrent (PsixaxisStat c);
fd_GetSIXAXISAnalog
ボタンの押し圧やアナログスティック、加速度センサ等の最新アナログ値を取得する。取得に当たり受信バッファを監視する必要はない。
short fd_GetSIXAXISAnalog (int ch);
ホームポジション・モーションファイル管理
ソースコード中にホームポジションやモーションを固定データとして記述してしまうと、それらを調整や編集してもソースプログラムに反映させるのは手動操作となり、反映させるには再度コンパイルしてプログラムをダウンロードし直さなくてはなりません。
本ライブラリではそれらのデータをFDIII-HCに装備したSDカード上のファイルとして扱う事ができるため、データのコピーやバックアップ等がPC等でも行えます。
fd_MMSD_Search
指定された名前でSDカードに保存されたモーションファイルを検索し、必要に応じてそのデータを取得する。
bool fd_MMSD_Search (const char *Name, PPose Motion, int *page);
fd_MMSD_SearchAndPlayMotion
指定された名前でSDカードに保存されたモーションファイルを検索し、見つかったら再生する。再生スピードや始点・終点の指示はできない。
bool fd_MMSD_SearchAndPlayMotion (const char *Name, PPose Motion, int *page, const PApplyPart pap);
fd_MMSD_Add
モーションデータに名前を付けてSDカードに保存する。同名のモーションファイルでの上書き保存はできない。
bool fd_MMSD_Add (const char *Name, PPose Motion, int page);
fd_MMSD_Del
指定された名前でSDカードに保存されたモーションファイルを検索し、存在すれば削除する。
bool fd_MMSD_Del (const char *Name);
- パラメータ
削除するモーション名 (最大8文字)
- 戻り値
ture: 成功
false: 失敗
fd_MMSD_FindFirst
SDカード内のモーションファイルの一覧を取得する際の、初期処理及びルートディレクトリへの移動を行う。実際のファイルの一覧取得はfd_MMSD_FindNextが担う。
bool fd_MMSD_FindFirst(void);
- パラメータ
なし
- 戻り値
true: 検索成功
false: 検索失敗
- 使用例
#include <fd.h>
void main (void) {
char name[10];
fd_Wait (2000);
if (fd_MMSD_FindFirst ()) {
int page;
while (fd_MMSD_FindNext (name, NULL, &page)) {
fd_printf ("[%s,%2d]", name, page);
}
}
}
fd_MMSD_FindNext
モーションファイルの一覧を取得する際の、次のファイルを見つける。モーションファイル名の取得と合わせて、モーションデータの読み込みも同時に行える。
先にfd_MMSD_FindFirstを実行しておく必要がある。
bool fd_MMSD_FindNext (char *Name, PPose Motion, int *page);
- パラメータ
- char *Name
見つかったモーション名を保存するchar *型の変数のアドレス
- PPose Motion
見つかったモーションデータを読み込むTPose構造体の変数のアドレス
もしくはNULL
- int *page
見つかったモーションデータのポーズ数を取得するint型の変数のアドレス
もしくはNULL
- 戻り値
true: 取得成功
false: 取得失敗
fd_MMSD_ChangeMotionName
指定された名前でSDカードに保存されたモーションファイルを検索し、存在すればモーション名を変更する。
bool fd_MMSD_ChangeMotionName (const char *OldName, const char *NewName);
- パラメータ
- const char *OldName
- const char *NewName
- 戻り値
true: 成功
false: 失敗
fd_MMSD_ReadHomePosition
SDカードに保存されたホームポジションファイルを検索し、存在すればデータを取得する。
bool fd_MMSD_ReadHomePosition (PHomePosition hp);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_MMSD_WriteHomePosition
SDカードにホームポジションデータを保存(上書きも含む)する。
bool fd_MMSD_WriteHomePosition (const PHomePosition hp);
- パラメータ
- 戻り値
true: 成功
false: 失敗
Dynamixelプロトコル
SpecやApplyPartによるモーションの管理APIでは用意されていないネットワーク上のデバイスの機能を、Dynamixelプロトコルを使用して直接扱うAPIです。
モーションの再生中であっても、センサからのフィードバックを検出したり、特殊なアイテムのデータを読み書きするといった事が可能です。
DX_ChangeBaudrate
ボーレートを変更する。ここで設定されるボーレートがネットワーク共通の通信速度となり、全てのAPIはこのボーレートを基準にして動作する。
なお、ライブラリ内では静的に1M[bps]で初期化されているため、そのままで支障がなければ特に変更の必要はないが、異なるボーレートのデバイスを使用する場合はfd_SetSpecで諸元を設定するよりも前にボーレートを変更しておく事。
bool DX_ChangeBaudrate (uint32_t baud);
DX_CalcTimeout
ボーレートとステータスパケットのパラメータサイズを元にタイムアウト時間を算定する。
uint32_t DX_CalcTimeout (int num);
DX_WriteByteData
指定されたIDを持つデバイスを対象に、指定アドレスのアイテムに指定された1バイトのデータを書き込む。
bool DX_WriteByteData (uint8_t id, uint8_t adr, uint8_t dat, uint32_t timeout, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_WriteWordData
指定されたIDを持つデバイスを対象に、指定アドレスのアイテムに指定された1ワード(2バイト)のデータを書き込む。
bool DX_WriteWordData (uint8_t id, uint8_t adr, uint16_t dat, uint32_t timeout, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_WriteBlockData
指定されたIDを持つデバイスを対象に、指定アドレスのアイテムを起点に指定されたサイズの連続したデータを書き込む。
bool DX_WriteBlockData (uint8_t id, uint8_t adr, const uint8_t *dat, uint8_t len, uint32_t timeout, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_ReadByteData
指定されたIDを持つデバイスを対象に、指定アドレスのアイテムから1バイトのデータを読み出す。
bool DX_ReadByteData (uint8_t id, uint8_t adr, uint8_t *result, uint32_t timeout, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_ReadWordData
指定されたIDを持つデバイスを対象に、指定アドレスのアイテムから1ワード(2バイト)のデータを読み出す。
bool DX_ReadWordData (uint8_t id, uint8_t adr, uint16_t *result, uint32_t timeout, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_ReadBlockData
指定されたIDを持つデバイスを対象に、指定アドレスのアイテムを起点に指定されたサイズの連続したデータを読み出す。
bool DX_ReadBlockData (uint8_t id, uint8_t adr, uint8_t *result, uint8_t len, uint32_t timeout, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_WriteSyncData
SYNCインストラクションを使用して複数のデバイスの同一アイテムに対して各々異なる値を一括送信する。
bool DX_WriteSyncData (const uint8_t *dat, uint8_t size, PDXAlarm errcode);
- パラメータ
- 戻り値
true: 成功
false: 失敗
DX_Ping
指定されたIDを持つデバイスを対象に、PINGを発行する。IDがわかっている場合に使用する。
bool DX_Ping (uint8_t id, uint32_t timeout, PDXAlarm errcode);
DX_Ping2
不特定のIDを持つデバイスを対象に、PINGを発行する(ブロードキャストIDを使用してPING)。IDがわからないデバイスに対して使用するため、ネットワーク上に接続されるデバイスは1台のみとする事。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool DX_Ping2 (uint8_t *id, uint32_t timeout, PDXAlarm errcode);
Dynamixelアクチュエータシリーズ専用
アクチュエータに共通のコントロールテーブルを扱うケースが多いため、Dynamixelプロトコルを直接扱わずに簡便にアクセスするためのAPIが用意されています。
なお、必ず各APIの持つ機能が利用可能なデバイスであるかの判断を行うため、ブロードキャストIDが使用できません。また、若干オーバヘッドが生じます。また、応答のタイムアウト時間は最大の理論値を元に内部で自動的に算出されます。
fd_DXGetModelNumber
本APIのみデバイスの種別を問わずモデルナンバー取得する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
uint16_t fd_DXGetModelNumber (uint8_t id, PDXAlarm errcode);
fd_DXLockParam
指定IDのアクチュエータに対して、EEPROMエリアの書き換え禁止を指令する。一度書き換え禁止を行うと、アクチュエータを再起動しない限りEEPROMエリアの書き換えは行えない。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXLockParam (uint8_t id);
- パラメータ
- uint8_t id
0～253: 対象デバイスのID
- 戻り値
true: 成功
false: 失敗
fd_DXEnableControl
指定IDのアクチュエータに対して、位置決め制御の開始・停止を指令する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXEnableControl (uint8_t id, bool On);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_DXSetPosition
指定IDのアクチュエータに対して、指定された位置を指令(アイテムのGOAL POSITIONへの書き込み)する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetPosition (uint8_t id, uint16_t Position);
- パラメータ
- 戻り値
true: 成功
false: 失敗
fd_DXGetPosition
指定IDのアクチュエータから、現在の位置を取得(アイテムのPRESENT POSITIONの読み出し)する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXGetPosition (uint8_t id, uint16_t *Position);
fd_DXSetSpeed
指定IDのアクチュエータに対して、指定された速度を指令(アイテムのMOVING SPEEDへの書き込み)する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetSpeed (uint8_t id, short Speed);
fd_DXSetTorqueLimit
指定IDのアクチュエータに対して、トルクリミッタの制限値を設定(アイテムのTORQUE LIMITへの書き込み)する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetTorqueLimit (uint8_t id, uint16_t Torque);
- uint8_t id
0～253: 対象デバイスのID
- uint16_t Torque
0～1023: トルクリミッタの制限値
- 戻り値
true: 成功
false: 失敗
fd_DXGetLoad
指定IDのアクチュエータから、現在の負荷を取得(アイテムのPRESENT LOADの読み出し)する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXGetLoad (uint8_t id, int16_t *Load);
fd_DXSetCompliance
指定IDのアクチュエータに対して、コンプライアンスを設定(アイテムのCW COMPLIANCE MARGINから4バイトへの書き込み)する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetCompliance (uint8_t id, uint8_t CWM, uint8_t CCWM, uint8_t CWS, uint8_t CCWS);
- uint8_t id
0～253: 対象デバイスのID
- uint8_t CWM
0～254: CWマージン
- uint8_t CCWM
0～254: CCWマージン
- uint8_t CWS
1～254: CWスロープ
- uint8_t CCWS
1～254: CCWスロープ
- 戻り値
true: 成功
false: 失敗
fd_DXSetPIDGain
指定IDのアクチュエータに対して、位置決め制御時のゲインを設定する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetPIDGain (uint8_t id, uint8_t PGain, uint8_t IGain, uint8_t DGain);
- uint8_t id
0～253: 対象デバイスのID
- uint8_t PGain
0～254: Pゲイン
- uint8_t IGain
0～254: Iゲイン
- uint8_t DGain
0～254: Dゲイン
- 戻り値
true: 成功
false: 失敗
fd_DXSetEndlessTurn
指定IDのアクチュエータに対して、無限回転・位置決めモードを切り替える。コントロールテーブルのEEPROMエリアの書き換えを伴うため、頻度が高い使用は禁物である。また、EEPROMエリアの書き換え禁止措置が講じられている場合は、モードの切り替えに失敗する。
fd_SetUVThresholdで指定された電圧を下回ると、実際の処理を行わない。
bool fd_DXSetEndlessTurn (uint8_t id, bool f);
SDファイルアクセス
SDカードのファイルへアクセスするためのAPIです。アプリケーションで独自のデータを保存したり読み出すといった事が可能です。
なお、対応するファイルシステムはFAT16のみとなり、FDIII-HCには時計機能が装備されない都合から日付・時刻を保存する機能はありません。
fd_WriteFile
SDカードにファイルを書き込む。既存ファイルの場合は上書きされる。
bool fd_FileWrite (const char *fname, const void *wdata, uint32_t wrsz, uint32_t *sfsz);
- パラメータ
- 戻り値
true: ファイルの書込み成功
false: ファイルの書込み失敗
- 使用例
#include "fd.h"
void main (void) {
uint32_t sz, rsz;
// 書込みバッファ
char buff[10] = "1234567890";
// 読込み内容の保存バッファ
char rbuff[21];
fd_Wait (2000);
// SDカードへTEST.DATを作成
if (fd_WriteFile ("TEST.DAT", buff, sizeof (buff), &sz)) {
rsz = sz;
// TEST.DATへデータを追加
if (fd_AppendFile ("TEST.DAT", buff, sizeof (buff), &sz)) {
rsz += sz;
// TEST.DATの内容を読み込む
if (fd_ReadFile ("TEST.DAT", rbuff, rsz, &sz)) {
// 末尾に0を追加することで文字列化
rbuff[sz] = 0x0;
fd_printf ("read buff = %s read size=%dn", rbuff, sz);
// TEST.DATを削除
fd_DeleteFile ("TEST.DAT");
}
}
}
}
fd_AppendFile
指定されたファイルの最後に追加で書込みを行う。
bool fd_AppendFile (const char *fname, const void *wdata, uint32_t wrsz, uint32_t *sfsz);
fd_ReadFile
指定されたファイルの内容をバッファへ読み込む。
bool fd_ReadFile (const char *fname, void *rdata, uint32_t rdsz, uint32_t *sfsz);
fd_DeleteFile
指定されたファイル・フォルダをSDカードより削除する。
bool fd_DeleteFile (const char *fname);
- パラメータ
- const char *fname
削除するファイル、又はフォルダ名
- 戻り値
true: 削除成功
false: 削除失敗
fd_FindFirst
フォルダ内の一覧を取得する際の、最初のファイル、又はフォルダを見つける。
bool fd_FindFirst(const char *foldername);
- パラメータ
- const char *foldername
一覧を取得したいフォルダ名
- 戻り値
true: オープン成功
false: オープン失敗
- 使用例
#include "fd.h"
void main (void) {
char fname[13];
TFileInfo fi;
fd_Wait (2000);
if (fd_SDIsAlive ()) {
// ルートフォルダを指定
if (fd_FindFirst("/")) {
// フォルダ内のファイル全てを検索
while (fd_FindNext (fname, &fi)) {
// フォルダを除いたファイルのみ表示
if (!(fi.fattr & AM_DIR)) fd_printf ("file:%s size=%dn", fname, fi.fsize);
}
}
}
}
fd_FindNext
フォルダ内の一覧を取得する際の、次のファイル、又はフォルダを見つける。名称と合わせて情報も取得する。
bool fd_SD_FindNext (char *fname, TFileInfo *types);
fd_MakeFolder
フォルダを作成する。
bool fd_MakeFolder (const char *foldername);
- パラメータ
- const char *foldername
作成するフルパスのフォルダ名
- 戻り値
true: 作成成功
false: 作成失敗
fd_FileExists
ファイル、又はフォルダの存在を確認をする。
bool fd_FileExists (const char *fname, TFileInfo *finfo);
- パラメータ
- 戻り値
true: 確認成功
false: 確認失敗
fd_SDIsAlive
SDカードの存在を確認する。
bool fd_SDIsAlive (void);
FREEDOM IIIライブラリ専用型定義
本ライブラリでは複数の情報を一括で扱うAPIが多いため、引数としてそれらの情報を取りまとめた構造体のポインタを渡すケースがあります。全てfd.h内で定義されていますので、詳細はソースを参照してください。
TModelNo
FREEDOM IIIライブラリで想定しているネットワークデバイスのModel No.の一覧が記述された列挙型変数。
主にTSpec構造体内の定義で使用される。
typedef enum {
DEV_AX12 = 12,
DEV_AXS1 = 13,
DEV_AX18 = 18,
DEV_DX113 = 113,
DEV_DX116 = 116,
DEV_DX117 = 117,
DEV_RX10 = 10,
DEV_RX24 = 24,
DEV_RX28 = 28,
DEV_MX28 = 29,
DEV_RX64 = 64,
DEV_EX106 = 107,
DEV_M168IO = 0x4001,
DEV_9DOF = 0x4002,
DEV_USS3 = 0x4004,
DEV_UDIII = 0x4010
} TModelNo;- DEV_AX12
AX-12, AX-12+, AX-12A
- DEV_AXS1
AX-S1
- DEV_AX18
AX-18F, AX-18A
- DEV_DX113
DX-113
- DEV_DX116
DX-116
- DEV_DX117
DX-117
- DEV_RX10
RX-10
- DEV_RX24
RX-24F
- DEV_RX28
RX-28
- DEV_MX28
MX-28
- DEV_RX64
RX-64
- DEV_EX106
EX-106+
- DEV_M168IO
Multifunction I/Oモジュール
- DEV_9DOF
9DOFセンサモジュール
- DEV_USS3
USS3
- DEV_UDIII
ユニバーサルドライバ3
TOpRange
アクチュエータの動作可能範囲をソフトウェア的に決めるための構造体。
主にTSpec構造体内の定義で使用される。
typedef struct {
short lowerlimit;
short upperlimit;
} TOpRange;- short lowerlimit
アクチュエータの動作下限位置
- short lowerlimit
アクチュエータの動作上限位置
TCompliance
アクチュエータのコンプライアンスをまとめた構造体。
主にTSpec構造体内の定義で使用される。
typedef struct {
uint8_t CWMargin;
uint8_t CCWMargin;
uint8_t CWSlope;
uint8_t CCWSlope;
} TCompliance;- uint8_t CWMargin
CWマージン
- uint8_t CCWMargin
CCWマージン
- uint8_t CWSlope
CWスロープ
- uint8_t CCWSlope
CCWスロープ
TSpec
デバイスの固有情報とTStructureのどの位置に適用するかを記述した構造体。fd_SetSpecにて使用する場合は、使用するデバイス数分の配列を定義した上で渡す。
typedef struct {
short id;
TModelNo ModelNo;
short *offset;
short Deg2Pos;
TOpRange OpRange;
uint16_t MaxSpeed;
uint16_t MaxTorque;
TCompliance Compliance;
} TSpec;- short id
対象デバイスのID
fd_SetSpecにて検出されないアラームとなる
- TModelNo ModelNo
対象デバイスのモデルNo.
fd_SetSpecにて不一致が検出されるとアラームとなる
- short *offset
対象デバイス(アクチュエータに限る)を適用する先のTStructure内のオフセット位置
例えばTStructureで定義された配列の10番目([9])の要素をオフセットとする場合は、fd_AxisOfsマクロを使用して以下の様に記述する
この設定により、各アクチュエータのIDとアプリケーション上で想定している構造が結び付けられる
- short Deg2Pos
対象デバイス(アクチュエータに限る)の位置と角度を変換する係数
計算式は以下の通り (POS:位置, DEG:角度x10, HP:ホーム位置)
POS = DEG * Deg2Pos / 1000 + HP
- TOpRange OpRange
対象デバイス(アクチュエータに限る)の動作可能範囲
ライブラリ内のソフト的なリミッタとして機能
- uint16_t MaxSpeed
対象デバイス(アクチュエータに限る)の初期の速度
fd_SetSpecにより指定された値が対象デバイスに書き込まれる
- uint16_t MaxTorque
対象デバイス(アクチュエータに限る)の初期のトルクリミット
fd_SetSpecにより指定された値が対象デバイスに書き込まれる
0の場合は書き込みを行わない
- TCompliance Compliance
対象デバイス(アクチュエータに限る)の初期のコンプライアンス
fd_SetSpecにより指定された値が対象デバイスに書き込まれる
全て0の場合は書き込みを行わない
PSpec
TSpecのポインタ型。
TStructure
アプリケーションにおける軸の配置(構造)を決定づける配列で、その軸のアクチュエータの角度や位置を保持するのに用いる。
ホームポジションやモーションはデバイスのIDで管理されるものではなく、この配列のどの位置に構造物のどの部位を割り当てるかで決定される。IDやアクチュエータの割り当てはTSpec内で定義される本配列に対するoffsetで二次的に決定される。
ライブラリとして管理できる最大軸数は60(=FD_MAX_AXIS_NUM)軸である。
typedef short TStructure[FD_MAX_AXIS_NUM];
PStructure
TStructureのポインタ型
THomePosition
各軸のホームポジションの位置を保持する配列。基本的にTStructureと全く同じで、アプリケーションにおける軸の配置(構造)を決定づける配列と同じ割り当てとする。
typedef TStructure THomePosition;
PHomePosition
THomePositionのポインタ型
TMotionAdj
複数のTPoseにて構成されるモーションにおいて、各々のポーズ間をつなぐ方法。
typedef enum {
ADJ_SACC_SDECEL,
ADJ_SACC,
ADJ_SDECEL,
ADJ_CONST
} TMotionAdj;- ADJ_SACC_SDECEL
S字(sin波)による加減速で2点間を補間
始点及び終点近傍の速度が遅くなるため、機械的な負荷が軽減される
- ADJ_SACC
S字(sin波)による加速で2点間を補間
始点のみ近傍の速度が遅くなる
- ADJ_SDECEL
S字(sin波)による減速で2点間を補間
終点のみ近傍の速度が遅くなる
- ADJ_CONST
定速度で2点間を補間
TPose
typedef struct {
TStructure Structure;
TMotionAdj Adj;
int Div;
} TPose;
PPose
TPoseのポインタ型。
TApplyPart
モーションの再生やアクチュエータへの設定を行う際に、それらを適用するTStructure内のどの部位(軸)に適用するかを定義する。さらに、モーションの再生中は、本構造体がバッファを含めたデータの実態を担う。そのため、内部的な値の保持やバッファの定義が多く、定義の際に使用するメンバーは限られる。
なお、宣言する際に少々トリッキーな手法を用いるため、使用する際はサンプルプログラム等で確認の事。
typedef struct {
int CurrentPose,
PoseNum,
MotionIntDiv,
MotionDiv;
TPose Motion[FD_MAX_POSE_NUM+1];
const bool Registed;
const bool Stop;
const bool Playing;
uint8_t Priority;
uint8_t PartNum;
short *Part[];
} TApplyPart;- int CurrentPose
定義及び引用不可 (現在のポーズ位置を保持)
- int PoseNum
定義及び引用不可 (現在のポーズ数を保持)
- int MotionIntDiv
定義及び引用不可 (モーション分割初期値を保持)
- int MotionDiv
定義及び引用不可 (モーション分割現在値を保持)
- TPose Motion[FD_MAX_POSE_NUM+1]
定義及び引用不可 (モーション再生用バッファ)
- const bool Registed
定義及び引用不可 (内部テーブルへの追加フラグ)
- const bool Stop
定義及び引用不可 (モーション停止指令)
- const bool Playing
定義及び引用不可 (モーションの再生中フラグ)
true: 再生中
false: 再生終了
- uint8_t Priority
優先度
値が小さいほど優先度が高く、複数のモーションを同時に再生する等で部位が干渉する場合は、本優先度が最も高いものが適用される
- uint8_t PartNum
Partで定義されるオフセットアドレスの要素数
- short *Part[]
TStructure内の配列のオフセットアドレス
ここで列挙される軸が適用対象となるが、例えばTStructureで定義された配列の1,2,4,5番目([0],[1],[3],[4])の4つの要素をオフセットとする場合は、fd_AxisOfsマクロを使用して以下の様に記述する。
fd_AxisOfs(0), fd_AxisOfs(1), fd_AxisOfs(3), fd_AxisOfs(4)
PApplyPart
TApplyPartのポインタ型。
TTrc100Stat
RC-100Bの1つのボタンの状態を示す。
typedef struct {
bool change;
bool down;
} TTrc100Stat;
Trc100Stat
RC-100Bの10個のボタンの状態を示す配列。それぞれの要素はTTrc100Statである。
typedef TTrc100Stat Trc100Stat[10];
配列の要素を抽出する際は、以下のマクロが使用できる。
#define _RC100_U 0 // 上方向キー
#define _RC100_D 1 // 下方向キー
#define _RC100_L 2 // 左方向キー
#define _RC100_R 3 // 右方向キー
#define _RC100_1 4 // 1ボタン
#define _RC100_2 5 // 2ボタン
#define _RC100_3 6 // 3ボタン
#define _RC100_4 7 // 4ボタン
#define _RC100_5 8 // 5ボタン
#define _RC100_6 9 // 6ボタン
Prc100Stat
Trc100Statのポインタ型。
TTsixaxisStat
SIXAXISないしDUALSHOCK3の1つのボタンの状態を示す。
typedef struct {
bool change;
bool down;
} TTsixaxisStat;
TsixaxisStat
SIXAXISないしDUALSHOCK3の17個のボタンの状態を示す配列。それぞれの要素はTTsixaxisStatである。
typedef TTsixaxisStat TsixaxisStat[17];
配列の要素を抽出する際は、以下のマクロが使用できる。
#define _SIXAXIS_BTN_U 0 // 上方向キー
#define _SIXAXIS_BTN_D 1 // 下方向キー
#define _SIXAXIS_BTN_L 2 // 左方向キー
#define _SIXAXIS_BTN_R 3 // 右方向キー
#define _SIXAXIS_BTN_TRIANGLE 4 // △ボタン
#define _SIXAXIS_BTN_SQUARE 5 // □ボタン
#define _SIXAXIS_BTN_CROSS 6 // ×ボタン
#define _SIXAXIS_BTN_CIRCLE 7 // ○ボタン
#define _SIXAXIS_BTN_R1 8 // R1ボタン
#define _SIXAXIS_BTN_L1 9 // L1ボタン
#define _SIXAXIS_BTN_L2 10 // L2ボタン
#define _SIXAXIS_BTN_R2 11 // R2ボタン
#define _SIXAXIS_BTN_SELECT 12 // SELECTボタン
#define _SIXAXIS_BTN_START 13 // STARTボタン
#define _SIXAXIS_BTN_PS 14 // PSボタン
#define _SIXAXIS_BTN_RANA 15 // 右アナログスティック
#define _SIXAXIS_BTN_LANA 16 // 左アナログスティック
PsixaxisStat
TsixaxisStatのポインタ型。
TDXAlarm
ライブラリ内及びネットワークデバイスで検出されたエラーないしアラームの情報。
typedef uint16_t TDXAlarm;
各ビットの割り当ては以下の通り。
ライブラリ内で定義されるアラーム。
#define ALARM_INVALID_DEVICE (1 << 15) // 諸元と異なるデバイス
#define ALARM_INVALID_ID (1 << 14) // 指定できないID
#define ALARM_DIFF_ID (1 << 13) // 想定されないID
#define ALARM_ILLEGAL_SIZE (1 << 12) // 想定されないデータサイズ
#define ALARM_INVALID_PARAM (1 << 11) // 想定されないパラメータサイズ
#define ALARM_COMM (1 << 10) // 通信ポートの不良
#define ALARM_CHECKSUM (1 << 9) // チェックサムの不一致
#define ALARM_TIMEOUT (1 << 8) // 通信タイムアウト
デバイスで定義されるアラーム。
#define ALARM_DX_INST (1 << 6) // 未定義のインストラクション
#define ALARM_DX_OVERLOAD (1 << 5) // 過負荷
#define ALARM_DX_CHECKSUM (1 << 4) // チェックサムの不一致
#define ALARM_DX_RANGE (1 << 3) // 設定範囲外
#define ALARM_DX_OVERHEAT (1 << 2) // 過加熱
#define ALARM_DX_ANGLE (1 << 1) // 位置指令の範囲外
#define ALARM_DX_OVERVOLTAGE (1 << 0) // 過電圧
PDXAlarm
TDXAlarmのポインタ型。
TAlarmStatus
ネットワークデバイスの持つIDとアラームを紐付けた構造体。
typedef struct {
uint8_t id;
TDXAlarm Status;
} TAlarmStatus;- uint8_t id
デバイスのID
- TDXAlarm Status
デバイスのアラーム
PAlarmStatus
TAlarmStatusのポインタ型。
TEdCmd
fd_AssistMotionEditで指定するコマンド。
typedef enum {
TED_PLAY,
TED_REVERSE,
TED_FOWARD,
TED_CAPTURE,
TED_DELETE,
TED_INSERT,
TED_REPLACE
} TEdCmd;- TED_PLAY
モーションデータを頭からフル再生
- TED_REVERSE
1つ前のポーズに軸を移行
- TED_FOWARD
1つ後のポーズに軸を移行
- TED_CAPTURE
現在の角度を取り込み、最後のポーズの後に追加
- TED_DELETE
現在の1ポーズを削除
- TED_INSERT
現在の角度を取り込み、現在のポーズの前に挿入
- TED_REPLACE
現在の角度を取り込み、現在のポーズを置換
TFileInfo
FATFSにおけるファイル情報構造体。
typedef struct {
uint32_t fsize; // File size
uint16_t fdate; // Last modified date
uint16_t ftime; // Last modified time
uint8_t fattr; // Attribute
char fname[13]; // Short file name (8.3 format)
} TFileInfo;
TColor
RGB555のカラーフォーマットと透過ビットを合わせた構造体。16bitでの指定も可能。
typedef union {
struct {
uint16_t B:5;
uint16_t G:5;
uint16_t R:5;
uint16_t t:1;
};
uint16_t WORD;
} TColor;
注意事項
スタックサイズ
関数内で動的に確保できるメモリのサイズはToppersのライブラリ(aspcore.h内に宣言がある)によって2kバイトに制限されています。これは変数の宣言も含まれ、本ライブラリで定義される型等はサイズが大きいため、不用意に宣言(記憶域をautoで指定)してしまうと気づかないうちにスタックフローが生じ、プログラムの動作に支障をきたします。
関数内でサイズの大きい変数を確保する場合はstatic指定子を付与し、静的にメモリを確保させる事でこの制限を回避する事ができます。
]]>
OpenOCD_0.6.0-dev-00569-g0eaa8e7-ft2232only.zip
。
![[worried]](http://www.besttechnology.co.jp/modules/knowledge/image/face/worried.png)
。
。
