# `NervesHubLink.Extensions.Health.DeviceStatus`
[🔗](https://github.com/nerves-hub/nerves_hub_link/blob/v2.12.0/lib/nerves_hub_link/extensions/health/device_status.ex#L6)

Structure for device status.

# `alarm_description`

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

# `alarm_id`

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

# `connection_status`

```elixir
@type connection_status() :: :lan | :internet | :disconnected
```

# `interface_identifier`

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

# `interface_type`

```elixir
@type interface_type() :: :ethernet | :wifi | :mobile | :local | :unknown
```

# `t`

```elixir
@type t() :: %NervesHubLink.Extensions.Health.DeviceStatus{
  alarms: %{required(alarm_id()) => alarm_description()},
  checks: %{required(String.t()) => %{pass: boolean(), note: String.t()}},
  connectivity: %{
    required(interface_identifier()) => %{
      type: interface_type(),
      present: boolean(),
      state: atom(),
      connection_status: connection_status(),
      metrics: %{required(String.t()) => number()},
      metadata: %{required(String.t()) => String.t()}
    }
  },
  metadata: %{required(String.t()) => String.t()},
  metrics: %{required(String.t()) => number()},
  timestamp: DateTime.t()
}
```

# `new`

```elixir
@spec new(Access.t()) :: t()
```

---

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