15ba670a026355ff5212ea5e81ed416af7c06ec6
driver / standard (pull_request) Successful in 17s
driver / lint (pull_request) Successful in 14s
driver / types (pull_request) Successful in 1m21s
driver / test (3.12) (pull_request) Successful in 3m44s
driver / test (3.13) (pull_request) Successful in 3m19s
driver / lowest (pull_request) Successful in 2m49s
driver / build (pull_request) Successful in 37s
driver / security (pull_request) Successful in 1m16s
CI / driver (pull_request) Successful in 5m32s
driver / publish (pull_request) Skipped
get_volume, get_mute, get_playback_state and get_current_track
answered 0, False, "STOPPED" and {} when the driver was not connected
or the read failed, so an unreachable speaker looked like a silent,
stopped one. They now raise ConnectionClosedException, or
ConnectionException / CommandErrorException with the SoCo error as
the cause.
get_playback_state called get_playback_state() on the SoCo object,
which SoCo does not have; the AttributeError was swallowed and every
speaker read as STOPPED. It now reads current_transport_state from
get_current_transport_info(). The tests mock the speaker with
MagicMock(spec=soco.SoCo), so a call to a method SoCo lacks fails.
Closes #9
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 |
eth0 when the speaker is wired, always wlan0 |
get_playback_state, get_current_track |
yes |
get_volume, set_volume, get_mute, set_mute |
yes |
play, pause, stop, next_track, previous_track |
yes |
get_group_info, get_zone_info |
yes |
Not supported
Configuration management (load_replace_candidate and load_merge_candidate raise
NotImplementedError), the CLI, and every routing, LLDP, ARP, NTP, SNMP, BGP, user
and environment getter: they return empty results.
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
Languages
Python
100%