SnmpKit.SnmpSim.Device.ModemUpgrade (snmpkit v0.6.4)

State machine and helpers for DOCSIS modem firmware upgrade simulation.

Supported core OIDs (per feature request):

docsIfDocsDevSwAdminStatus — 1.3.6.1.2.1.69.1.3.1.0 (INTEGER; read-write)
docsIfDocsDevSwOperStatus — 1.3.6.1.2.1.69.1.3.2.0 (INTEGER; read-only)
docsIfDocsDevSwServer — 1.3.6.1.2.1.69.1.3.3.0 (OCTET STRING; read-write)
docsIfDocsDevSwFilename — 1.3.6.1.2.1.69.1.3.4.0 (OCTET STRING; read-write)

Notes:

AdminStatus write triggers the upgrade when set to a specific value (we use 3 for "upgradeFromMgt" by default).
OperStatus transitions through realistic steps with configurable timings.
Errors map to SNMP statuses at the PDU processor layer; here we return pure state and let callers map to errors.

Summary

Functions

advance_phase(state, atom)

Advance the upgrade to the next phase. Returns {scheduled_msgs, new_state}.

apply_set(field, value, state)

Apply a simple field SET for server/filename/admin. Returns updated state. Validation is basic here; callers should enforce SNMP type checks.

default_state(opts \\ %{})

Build default upgrade state. Accepts optional opts

trigger(state, opts \\ [])

Trigger the upgrade. Returns {scheduled_msgs, new_state}.

Types

t()

@type t() :: %{
  server: String.t(),
  filename: String.t(),
  admin_status: integer(),
  oper_status: integer(),
  progress: integer(),
  started_at_ms: integer() | nil,
  upgrade_enabled: boolean(),
  post_upgrade_version: String.t() | nil,
  default_version: String.t() | nil,
  invalid_server_regex: Regex.t() | nil,
  delay_ms: %{
    name_check: non_neg_integer(),
    download: non_neg_integer(),
    apply: non_neg_integer()
  }
}