Skip to content
Get started

Sendspin Switch

The sendspin switch platform controls the Sendspin client. The Sendspin hub must be configured on the same device. There are two types:

  • enabled: Enables and disables the client. While it is off, the device stops advertising itself to Sendspin servers, closes any server connection, and rejects playback and control commands from the other Sendspin components. Turning it on starts the client again.
  • unpaired_access: Turns unpaired access on and off. While it is off, only servers that have paired with the device can play on it. Before turning it off, make sure the device offers a pairing code, otherwise no new server can pair. This switch replaces the hub’s unpaired_access option, and the two cannot be configured together.

Each switch restores its previous state on boot and defaults to on, so a setting that was turned off stays off after a restart. Only one switch of each type can be configured.

This platform only works on ESP32-based chips.

# Example configuration entry
sendspin:
switch:
- platform: sendspin
name: "Sendspin Enabled"
type: enabled
- platform: sendspin
name: "Sendspin Unpaired Access"
type: unpaired_access
  • type (Required, enum): The kind of Sendspin switch. One of enabled or unpaired_access.
  • sendspin_id (Optional, ID): The ID of the Sendspin hub to attach to. Only needed if you have more than one hub configured.
  • restore_mode (Optional): Control how the switch attempts to restore state on bootup. Defaults to RESTORE_DEFAULT_ON. See Switch for the options.
  • All other options from Switch, except inverted.

TIP

For an unpaired_access switch, set restore_mode: RESTORE_DEFAULT_OFF if unpaired access should stay off when the saved state is lost, for example after renaming the switch.