AVModbus.Serial.Transport behaviour (avmodbus v0.1.0)

Copy Markdown View Source

Modbus serial transport adapter の contract です。

open/1 は instance ごとの設定を keyword list で受け取ります。read/2 は timeout を millisecond で受け取り、write/2 は response の受信へ安全に移れる時点で返す必要があります。manual DE / RE を使う RS485 adapter では、送信完了待ちと direction の切り替えも write/2 の責務です。

Summary

Types

handle()
options()

Callbacks

close(handle)
open(options)
read(handle, non_neg_integer)
write(handle, iodata)

Types

handle()

@type handle() :: term()

options()

@type options() :: keyword()

Callbacks

close(handle)

@callback close(handle()) :: :ok | {:error, term()}

open(options)

@callback open(options()) :: {:ok, handle()} | {:error, term()}

read(handle, non_neg_integer)

@callback read(handle(), non_neg_integer()) :: {:ok, binary()} | {:error, term()}

write(handle, iodata)

@callback write(handle(), iodata()) :: :ok | {:error, term()}