5. API 関数仕様
5.3 シリアルインターフェース制御関数(調歩同期式)
5. API 関数仕様
5.3.2 UARTSendMessage
[構文]
int UARTSendMessage (
unsigned char *pucSendMessage, unsigned char ucCheckSumFlg)
[機能]
S1V50300にREQメッセージを送信します。
[入力引数]
pucSendMessage REQメッセージが格納されたメモリ領域の先頭アドレスを設定します。
ucCheckSumFlg チェックサムの有効/無効を設定します(0: disable / 1: enable)
[出力引数]
なし
[戻り値]
正常終了した場合は0を返し、それ以外は以下に示すエラーコードを返します。
エラーコード 値 説明
ERR_SUCCESS 0 正常終了した場合に返します
ERR_NULL_PTR -1 引数がNULLポインタの場合に返します
[機能説明]
引数指定したREQメッセージのバイト列をS1V50300に送信します。
チェックサム機能は、Bootモードメッセージの送信のときのみ使用できます。Mainモードメッ セージの送信では、チェックサム機能を有効にしても使用できませんのでご注意ください。
5. API 関数仕様
5.3.3 UARTReceiveMessage
[構文]
int UARTReceiveMessage (
unsigned short *pucMessageID, unsigned char *pucReceivedMessage)
[機能]
S1V50300からのINDメッセージを受信します。
[入力引数]
なし
[出力引数]
pucMessageID INDメッセージのメッセージIDを格納する変数のポインタを設定 します。
pucReceivedMessage IND メッセージを格納するメモリ領域の先頭アドレスを設定しま す。
[戻り値]
正常終了した場合は0を返し、それ以外は以下に示すエラーコードを返します。
エラーコード 値 説明
ERR_SUCCESS 0 正常終了した場合に返します
ERR_NULL_PTR -1 引数がNULLポインタの場合に返します ERR_GET_ERROR_CODE -2 S1V50300 か ら の 受 信 メ ッ セ ー ジ に エ
ラーコードが含まれている場合に返しま す
ERR_RESERVED_MESSAGE_ID -3 S1V50300 からの受信メッセージが予約 されたIDの場合に返します
ERR_ISC_VERSION_RESP -4 ISC_VERSION_RESP の内容が仕様に一 致しない場合に返します
ERR_TIMEOUT 1 設 定 し た タ イ ム ア ウ ト 時 間 内 に 、 S1V50300 から通知されるメッセージが 受信されない場合に返します
[機能説明]
S1V50300から通知されるINDメッセージを受信します。
出力引数であるpucReceivedMessageIDには、取得したINDメッセージのIDの値が格納されま す。また、pucReceivedMessageで設定されるメモリ領域には、INDメッセージのデータ全体が 格 納 さ れ ま す 。 本 関 数 の 外 で IND メ ッ セ ー ジ の デ ー タ を 使 用 し な い 場 合 は 、 pucReceivedMessageにNULLを設定してくだい。
5.3.4 UARTSendByte
[構文]
void UARTSendByte (
unsigned char ucSendData)
[機能]
1バイトのデータを送信します。
[入力引数]
ucSendData 1バイトの送信データを設定します。
[出力引数]
なし
[戻り値]
なし
[機能説明]
S1V50300へ1バイトのデータをUART経由で送信します。
5. API 関数仕様
5.3.5 UARTReceiveByte
[構文]
unsigned char UARTReceiveByte ( void )
[機能]
1バイトのデータを受信します。
[入力引数]
なし
[出力引数]
なし
[戻り値]
1バイトの受信データを返します。
[機能説明]
S1V50300から1バイトのデータをUART経由で受信します。