Files
napalm-sonos/README.md
T
Christian Manivong 56e0560eb2
driver / lint (pull_request) Successful in 15s
driver / standard (pull_request) Successful in 17s
driver / types (pull_request) Successful in 1m0s
driver / test (3.13) (pull_request) Successful in 4m13s
driver / test (3.12) (pull_request) Successful in 4m15s
driver / lowest (pull_request) Successful in 3m42s
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m8s
CI / driver (pull_request) Successful in 5m38s
driver / publish (pull_request) Skipped
fix(driver): leave unsupported getters to NAPALM's stubs
get_config() overrode NAPALM's stub with `return {}` and took no
arguments, so get_config(retrieve="running") raised TypeError, which a
caller reports as a failed configuration backup on every poll. The
other getters a speaker has nothing for (environment, optics, routing,
ARP, MAC table, LLDP, NTP, SNMP, BGP, probes, users, network instances,
firewall policies) had the same shape: an empty answer reads as
"implemented, nothing there", and get_route_to() required an argument
NAPALM defaults.

All of them are gone; NAPALM's stubs raise NotImplementedError.

Closes #13
2026-11-12 18:54:07 +01:00

2.5 KiB

napalm-sonos

NAPALM driver for Sonos speakers, built on napalm-device-types (MediaDriver). It talks to the speaker through SoCo.

Tested against

Model Firmware
not recorded yet

Connection

UPnP/SOAP over HTTP on port 1400, through SoCo. A Sonos speaker takes no login: username and password are accepted for NAPALM's constructor and ignored. open() reads the speaker info once; is_alive() checks that TCP port 1400 accepts a connection.

from napalm import get_network_driver

driver = get_network_driver("sonos")
with driver("192.0.2.20") as speaker:
    print(speaker.get_facts())
    print(speaker.get_playback_state())

Supported

Getter / action
get_facts from the speaker info read at open()
get_interfaces, get_interfaces_ip one interface, wlan0, for the speaker's network connection (see below)
get_playback_state {"state": "playing"|"paused"|"stopped"|"transitioning", "source": …} (media contract)
get_current_track yes
get_volume, set_volume, get_mute, set_mute yes
play, pause, stop, next_track, previous_track yes
get_zone_info [{"name", "coordinator", "members"}] (media contract)
get_group_info the group's coordinator and members with uid and address

Whether a speaker is wired or wireless is not known: SoCo offers no reading for it (deviceProperties is the UPnP service of that name, and none of its actions says), so the driver reports no eth0. The one interface keeps the name wlan0; it stands for the speaker's connection, whatever its medium.

Not supported

Configuration management (load_replace_candidate and load_merge_candidate raise NotImplementedError), configuration export (get_config), the CLI, and every routing, LLDP, ARP, MAC table, NTP, SNMP, BGP, optics, probe, user, network-instance, firewall-policy and environment getter. The driver leaves those getters to NAPALM, whose stubs raise NotImplementedError: a speaker has no such data, and an empty answer would read as "read, nothing there".

Installation

pip install napalm-sonos

Development

The rules are in STANDARDS.md.

python -m venv .venv && .venv/bin/pip install -e ".[dev]"
.venv/bin/pytest --cov

License

Apache-2.0