View Source Grizzly.StatusReporter behaviour (grizzly v4.0.0)

A behaviour that is used to report the status of various parts of the Grizzly runtime

Link to this section Summary

Types

The various status of a firmware update of the Z-Wave module

Callbacks

This callback is called when Grizzly starts up zipgateway and able to establish everything is running correctly.

This callback is executed during a firmware update of the Z-Wave module

Link to this section Types

Link to this type

zwave_firmware_status()

View Source
@type zwave_firmware_status() ::
  :started | :success | {:error, Grizzly.FirmwareError.t()}

The various status of a firmware update of the Z-Wave module

  • :started - the firmware update has been initiated and all validation of the firmware update is complete.
  • :success - the firmware update of the Z-Wave module is successful.
  • {:skipped, reason} - the Z-Wave firmware on the module cannot be updated with any known firmware.
  • {:error, reason} - A firmware update of the Z-Wave module was attempted but failed for some reason.

Link to this section Callbacks

@callback ready() :: :ok

This callback is called when Grizzly starts up zipgateway and able to establish everything is running correctly.

After this callback is called the implementor can assume the it is safe to access the Z-Wave network through Grizzly.

Link to this callback

zwave_firmware_update_status(zwave_firmware_status)

View Source
@callback zwave_firmware_update_status(zwave_firmware_status()) :: :ok

This callback is executed during a firmware update of the Z-Wave module