Excansock (Excansock v1.0.3)

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

close(pid)

Close CAN socket.

open(pid, name, canfd \\ false)

Open CAN socket.

recv_own_messages(pid, value)

Enable / disable receiving own messages

send(pid, frame)

Send CAN message

set_error_filter(pid, filter)

Set bus error filter

set_filters(pid, filters)

Set CAN filters

set_loopback(pid, value)

Enable / disable CAN loopback

start_link(opts \\ [])

Start up Excansock GenServer.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

close(pid)

@spec close(GenServer.server()) :: :ok | :error

Close CAN socket.

open(pid, name, canfd \\ false)

@spec open(GenServer.server(), binary(), boolean()) :: :ok | :error

Open CAN socket.

recv_own_messages(pid, value)

@spec recv_own_messages(GenServer.server(), boolean()) :: :ok

Enable / disable receiving own messages

send(pid, frame)

@spec send(GenServer.server(), Excansock.CanFrame.t()) :: :ok

Send CAN message

set_error_filter(pid, filter)

@spec set_error_filter(GenServer.server(), integer()) :: :ok

Set bus error filter

set_filters(pid, filters)

@spec set_filters(GenServer.server(), [Excansock.CanFilter.t()]) :: :ok

Set CAN filters

set_loopback(pid, value)

@spec set_loopback(GenServer.server(), boolean()) :: :ok

Enable / disable CAN loopback

start_link(opts \\ [])

@spec start_link([term()]) :: {:ok, pid()} | {:error, term()}

Start up Excansock GenServer.