noka @willow-micro / SerialConnect

Dependencies:   AsyncSerial

Embed: (wiki syntax)

« Back to documentation index

SerialConnect Class Reference

SerialConnect Class Reference

NSC形式パケットの送受信 More...

#include <SerialConnect.hpp>

Public Member Functions

 SerialConnect (PinName txpin, PinName rxpin, uint32_t payload_size, uint32_t baudrate=115200, uint32_t uart_fifo_buffer_size=256)
 コンストラクタ 片方向通信でTx, Rxのどちらかのピンを使わない場合は,ピン番号を"NC"とすること.
virtual ~SerialConnect (void)
 デストラクタ
virtual void send (const uint8_t *payload_array)
 パケットの送信
virtual update_result_e update (void)
 パケット受信処理を行う
virtual uint8_t get_payload_by_1byte (uint8_t index)
 ペイロードのGetter

Detailed Description

NSC形式パケットの送受信

Definition at line 60 of file SerialConnect.hpp.


Constructor & Destructor Documentation

SerialConnect ( PinName  txpin,
PinName  rxpin,
uint32_t  payload_size,
uint32_t  baudrate = 115200,
uint32_t  uart_fifo_buffer_size = 256 
)

コンストラクタ 片方向通信でTx, Rxのどちらかのピンを使わない場合は,ピン番号を"NC"とすること.

Parameters:
txpinパケットを送信するピン(PinNames.hで定義されたもの)
rxpinパケットを受信するピン(PinNames.hで定義されたもの)
payload_sizeやりとりするパケットのペイロードの大きさ(Byte)
baudrateボーレート(省略可,デフォルトは115200bps)
uart_fifo_buffer_sizeUARTのリングバッファのサイズ(省略可,デフォルトは256Byte)

Definition at line 22 of file SerialConnect.cpp.

~SerialConnect ( void   ) [virtual]

デストラクタ

Definition at line 34 of file SerialConnect.cpp.


Member Function Documentation

virtual uint8_t get_payload_by_1byte ( uint8_t  index ) [virtual]

ペイロードのGetter

格納済みのペイロードを読み出します。 配列の要素取得と同じように、インデックスを引数として渡します。

注意: 必ずupdateメソッドでペイロードの受信完了を確認し,その後実行してください

Parameters:
index要素のインデックス
Returns:
uint8_t 要素

Definition at line 128 of file SerialConnect.hpp.

void send ( const uint8_t *  payload_array ) [virtual]

パケットの送信

Parameters:
uint8_t*payload_array 送信したい配列のポインタ

Definition at line 40 of file SerialConnect.cpp.

update_result_e update ( void   ) [virtual]

パケット受信処理を行う

メインループ内で毎回必ずこのメソッドを呼び、返り値を見てOKならペイロードの格納が完了しています。

Return values:
update_result_eREADY ペイロードの正常な受信および格納が完了
update_result_eNOT_READY ペイロードの受信処理が続行中

Definition at line 58 of file SerialConnect.cpp.