Add since metadata across the public API and bump the version to 0.10.0

lib/espex.ex

@@ -111,6 +111,7 @@ defmodule Espex do
   @spec device_config(GenServer.server()) :: DeviceConfig.t()
   def device_config(server \\ Server), do: Server.device_config(server)
 
+  @doc since: "0.10.0"
   @doc """
   Replace or merge the running server's `%DeviceConfig{}`.
 
@@ -145,6 +146,7 @@ defmodule Espex do
     Server.update_device_config(server, config_or_opts)
   end
 
+  @doc since: "0.10.0"
   @doc """
   Replace some or all of the running server's adapter modules.
 
@@ -176,6 +178,7 @@ defmodule Espex do
     Server.update_adapters(server, changes)
   end
 
+  @doc since: "0.10.0"
   @doc """
   Ask every currently-connected client to disconnect.
 
@@ -198,7 +201,8 @@ defmodule Espex do
   that is already being disconnected. Use an `Espex.ConnectionListener`
   or `connected_clients/1` to observe the drop and the return.
 
-  `reason` is carried in `DisconnectRequest.reason` (ESPHome 2026.7+):
+  `reason` is carried in `DisconnectRequest.reason` (ESPHome 2026.7+;
+  the argument is new in 0.10.0):
 
     * `:unspecified` (default) — an ordinary reconnect request; Home
       Assistant comes back after its cooldown.
@@ -240,6 +244,7 @@ defmodule Espex do
     end)
   end
 
+  @doc since: "0.7.0"
   @doc """
   Broadcast a Z-Wave home-ID change to **every** connected client.
 
@@ -270,6 +275,7 @@ defmodule Espex do
     end)
   end
 
+  @doc since: "0.5.0"
   @doc """
   List the currently-connected native-API clients as
   `Espex.ClientInfo` structs.

lib/espex/bluetooth_proxy.ex

@@ -1,4 +1,5 @@
 defmodule Espex.BluetoothProxy do
+  @moduledoc since: "0.2.0"
   @moduledoc """
   Behaviour for Bluetooth Low Energy active-proxy adapters.
 

lib/espex/bluetooth_proxy/characteristic.ex

@@ -1,4 +1,5 @@
 defmodule Espex.BluetoothProxy.Characteristic do
+  @moduledoc since: "0.2.0"
   @moduledoc """
   A GATT characteristic inside a `Espex.BluetoothProxy.Service`.
 

lib/espex/bluetooth_proxy/descriptor.ex

@@ -1,4 +1,5 @@
 defmodule Espex.BluetoothProxy.Descriptor do
+  @moduledoc since: "0.2.0"
   @moduledoc """
   A GATT descriptor inside a `Espex.BluetoothProxy.Characteristic`.
 

lib/espex/bluetooth_proxy/service.ex

@@ -1,4 +1,5 @@
 defmodule Espex.BluetoothProxy.Service do
+  @moduledoc since: "0.2.0"
   @moduledoc """
   A GATT service streamed from a `Espex.BluetoothProxy` adapter.
 

lib/espex/bluetooth_scanner.ex

@@ -1,4 +1,5 @@
 defmodule Espex.BluetoothScanner do
+  @moduledoc since: "0.2.0"
   @moduledoc """
   Behaviour for Bluetooth Low Energy scanner adapters.
 

lib/espex/client_info.ex

@@ -1,4 +1,5 @@
 defmodule Espex.ClientInfo do
+  @moduledoc since: "0.5.0"
   @moduledoc """
   A snapshot of one currently-connected ESPHome native-API client.
 

lib/espex/connection_listener.ex

@@ -1,4 +1,5 @@
 defmodule Espex.ConnectionListener do
+  @moduledoc since: "0.5.0"
   @moduledoc """
   Behaviour for being notified when the set of connected native-API
   clients changes.

lib/espex/device_config.ex

@@ -154,6 +154,7 @@ defmodule Espex.DeviceConfig do
   def encrypted?(%__MODULE__{psk: nil}), do: false
   def encrypted?(%__MODULE__{psk: <<_::binary-size(32)>>}), do: true
 
+  @doc since: "0.4.0"
   @doc """
   Set the PSK from runtime-supplied input (e.g. a
   `NoiseEncryptionSetKeyRequest`), returning a tagged result.
@@ -172,6 +173,7 @@ defmodule Espex.DeviceConfig do
     end
   end
 
+  @doc since: "0.10.0"
   @doc """
   Validate a caller-built `%DeviceConfig{}` for use at runtime, returning
   a tagged result.
@@ -186,6 +188,7 @@ defmodule Espex.DeviceConfig do
   def validate(%__MODULE__{psk: psk} = config) when is_binary(psk), do: put_psk(config, psk)
   def validate(%__MODULE__{}), do: {:error, :invalid_psk_length}
 
+  @doc since: "0.10.0"
   @doc """
   Apply runtime-supplied keyword options onto an existing config,
   returning a tagged result.

lib/espex/entity_provider.ex

@@ -234,6 +234,7 @@ defmodule Espex.EntityProvider do
   """
   @callback handle_command(command :: struct()) :: :ok | {:error, term()}
 
+  @doc since: "0.9.0"
   @doc """
   Same as `c:handle_command/1`, but also given the originating
   connection's security context. Preferred when exported — Espex calls

lib/espex/psk_store.ex

@@ -1,4 +1,5 @@
 defmodule Espex.PskStore do
+  @moduledoc since: "0.4.0"
   @moduledoc """
   Behaviour for persisting the Noise pre-shared key when Home Assistant
   provisions or rotates it at runtime via `NoiseEncryptionSetKeyRequest`.

lib/espex/serial_proxy.ex

@@ -79,6 +79,7 @@ defmodule Espex.SerialProxy do
       drive, a list of `:rts` / `:dtr` (default `[]`). Advertised to the
       client as a bitmask so it knows which pins `set_modem_pins/3` will
       honour. Set it when the adapter implements `c:set_modem_pins/3`.
+      Since 0.10.0.
 
   The list is snapshotted at connection-accept time and cached by the
   client; see the "Architecture" guide for why changes require a
@@ -229,6 +230,7 @@ defmodule Espex.SerialProxy do
     ]
   end
 
+  @doc since: "0.8.0"
   @doc """
   The fallback options used when espex lazily opens an instance and the
   adapter does not export `c:default_open_opts/1`: 9600-8-N-1, no flow
@@ -301,6 +303,7 @@ defmodule Espex.SerialProxy do
   @callback request(handle(), request_type()) ::
               {:ok, request_status()} | {:error, term()}
 
+  @doc since: "0.8.0"
   @doc """
   Return the options espex should use when it opens `instance` lazily —
   i.e. when a client sends a write/subscribe/modem-pins/flush request

lib/espex/serial_proxy/info.ex

@@ -13,7 +13,7 @@ defmodule Espex.SerialProxy.Info do
   alias Espex.Proto
 
   @type port_type :: :ttl | :rs232 | :rs485
-  @typedoc "A modem control line the port can drive via `set_modem_pins/3`."
+  @typedoc "A modem control line the port can drive via `set_modem_pins/3`. Since 0.10.0."
   @type line :: :rts | :dtr
 
   @type t :: %__MODULE__{
@@ -49,6 +49,7 @@ defmodule Espex.SerialProxy.Info do
     }
   end
 
+  @doc since: "0.10.0"
   @doc """
   Encode a list of modem lines as the `configured_line_states` bitmask
   (`:rts` → bit 0, `:dtr` → bit 1).

lib/espex/supervisor.ex

@@ -71,9 +71,10 @@ defmodule Espex.Supervisor do
   connections are built from, `Espex.update_adapters/2` swaps the adapter
   modules, and `Espex.disconnect_clients/1` asks every connected client
   to disconnect and come back — together they make Home Assistant re-read
-  `DeviceInfo` and the entity list without restarting this tree. `disconnect_grace_ms` bounds how long a
-  connection waits for the client's `DisconnectResponse` before closing
-  the socket anyway.
+  `DeviceInfo` and the entity list without restarting this tree. All
+  three, and the option below, are new in 0.10.0. `disconnect_grace_ms`
+  bounds how long a connection waits for the client's
+  `DisconnectResponse` before closing the socket anyway.
   """
 
   use Supervisor
@@ -194,6 +195,7 @@ defmodule Espex.Supervisor do
   @spec registry_name(atom()) :: atom()
   def registry_name(server_name), do: Module.concat(server_name, "Registry")
 
+  @doc since: "0.5.0"
   @doc """
   Return the conventional connected-clients Registry name for a given
   server name. This is the unique-key registry that backs

mix.exs

@@ -2,7 +2,7 @@ defmodule Espex.MixProject do
   use Mix.Project
 
   @app :espex
-  @version "0.9.0"
+  @version "0.10.0"
   @source_url "https://github.com/bbangert/espex"
 
   def project do