# `Grizzly.FirmwareUpdates`
[🔗](https://github.com/smartrent/grizzly/blob/v9.1.4/lib/grizzly/firmware_updates.ex#L1)

Module for upgrading firmware on target devices.

Required options:

* `manufacturer_id` - The unique id identifying the manufacturer of the target device
* `firmware_id` - The id of the current firmware

Other options:

* `device_id` - Node id of the device to be updated. Defaults to 1 (controller)
* `firmware_target` - The firmware target id. Defaults to 0 (the ZWave chip)
* `max_fragment_size` - The maximum number of bytes that will be transmitted at a time. Defaults to 2048.
* `hardware_version` - The current hardware version of the device to be updated. Defaults to 0.
* `activation_may_be_delayed?` - Whether it is permitted for the device may delay the actual firmware update. Defaults to false.
* `handler` - The process that will receive callbacks. Defaults to the caller.any()

The firmware update process is as follows:

  1. Grizzly sends a `firmware_md_get` command to the target device to get the manufacturer_id, hardware_id, max_fragment size,
  among other info needed to specify a firmware update request. The info is returned via a `firmware_md_report` command.

  2. Grizzly uses this info to send a `firmware_update_md_request` command to the target device, telling it to initiate the image
  uploading process. The checksum of the entire firmware image is added to the request. The target device says yeah or nay via a
  `firmware_update_md_request_report` command.

  3. If the target device agrees to have its firmware updated, it next sends a first `firmware_update_md_get` command to Grizzly asking
  for a number_of_reports (a bunch of firmware image fragment uploads) starting at fragment `report_number`.

  4. Grizzly responds by sending the requested series of `firmware_update_md_report` commands to the target device, each one containing
  a firmware image fragment, with a checksum for the command.

  5. Once a series of uploads is completed, the target device either asks for more fragments via another `firmware_update_md_get` command,
  or it sends a `firmware_update_md_status_report` command either to cancel the yet incomplete upload (bad command checksums!),
  or to announce that the update has completed either successfully (with some info about what happens next) or in failure
  (invalid overall image checksum!).

  6. As part of a successful `firmware_update_md_status_report` command, the target device tells Grizzly whether the new firmware
  needs to be activated. If it does, Grizzly would then be expected to send a `firmware_update_activation_set` command which success
  is reported by the target device via a `firmware_update_activation_report` command.

# `image_path`

```elixir
@type image_path() :: String.t()
```

# `opt`

```elixir
@type opt() ::
  {:manufacturer_id, non_neg_integer()}
  | {:firmware_id, non_neg_integer()}
  | {:device_id, Grizzly.node_id()}
  | {:hardware_version, byte()}
  | {:handler, pid() | module() | {module(), keyword()}}
  | {:firmware_target, byte()}
  | {:max_fragment_size, non_neg_integer()}
  | {:activation_may_be_delayed?, boolean()}
  | {:transmission_delay, pos_integer()}
  | {:progress_timeout, timeout()}
  | {:max_fragment_retries, non_neg_integer()}
```

# `firmware_image_fragment_count`

```elixir
@spec firmware_image_fragment_count() ::
  {:ok, non_neg_integer()} | {:error, :not_updating}
```

# `firmware_update_running?`

```elixir
@spec firmware_update_running?() :: boolean()
```

A firmware update is in progress when a `FirmwareUpdateRunner` process is running
and has received at least one request for one or more image fragments OR when
an `OTWUpdateRunner` process is running.

# `progress`

```elixir
@spec progress() :: {non_neg_integer(), pos_integer()} | nil
```

Returns the progress of the current firmware update, if any, as a tuple containing
the last requested fragment index and the total number of fragments.

# `start_firmware_update`

```elixir
@spec start_firmware_update(image_path(), [opt()]) ::
  :ok | {:error, :image_not_found} | {:error, :busy}
```

Starts the firmware update process

# `stop_firmware_update`

```elixir
@spec stop_firmware_update() :: :ok
```

Stop the current firmware update runner, if any.

---

*Consult [api-reference.md](api-reference.md) for complete listing*