View Source QMI.Supervisor (qmi v0.8.5)

Main supervisor for QMI processes

Link to this section Summary

options()

QMI Supervisor options

Returns a specification to start this module under a supervisor.

Start the supervisor

@type options() :: [
  ifname: String.t(),
  device_path: Path.t(),
  name: atom(),
  indication_callback: QMI.indication_callback_fun()
]

QMI Supervisor options

:ifname - the network interface name. i.e. "wwan0"
:device_path - the path to the QMI control device. Defaults to "/dev/cdc-wdm<index>" where index matches the ifname index.
:name - an optional name for this GenServer
:indication_callback - a function that is ran when an indication is received from QMI.

Returns a specification to start this module under a supervisor.

@spec start_link(options()) :: Supervisor.on_start()

Start the supervisor

The :name option is required and will be the QMI supervisor process. Pass this name to all functions that have a qmi parameter.