Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mvdwetering committed Mar 22, 2017
1 parent 053c150 commit a3fb015
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
14 changes: 11 additions & 3 deletions docs/DESIGN.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ Design stuff document

This file contains some design decisions. Mainly for future me.

Scope
=====
The library is intended for automation applications, so control, not configuration.
So things like setting/reading volume, mute inputs are in.
Things like setting name, speaker delays etc... are out for now.

Controlling the subunits like Tuner and other Mediaplayer-like components would be nice, but also out of scope for now.


Input detection
===============
Expand Down Expand Up @@ -33,21 +41,21 @@ For now lets not attempt to limit zone inputs.


Zone detection
--------------
==============
Since there is no explicit command for supported zones, just check availability by checking all known zone subunits
(``MAIN``, ``ZONE2``, ``ZONE3`` and ``ZONE4``), if they respond properly to ``AVAIL`` then they are on the device.


Keep alive
----------
==========
The unit can go to sleep of break the connection in case of IP.
The first command received when the unit is asleep is lost.
To avoid this keep the connection alive by sending a dummy command when the connection is idle for a while.
The YNCA spec recommends using the ``@SYS:MODELNAME=?`` command.


Update callback
---------------
===============
The current update callback does not indicate what changed.
I currently have no need to know what changed, this can always be implemented later.
A nice way would be to allow subscriptions on attributes, but there seems no standard way to do that.
2 changes: 1 addition & 1 deletion docs/PROTOCOL.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
YNCA Protocol recap
===================

This is a short collection of the basic for the YNCA protocol. The specs are always leading!
This is a short collection of the basics for the YNCA protocol. The real specs are always leading!


Supported receivers
Expand Down

0 comments on commit a3fb015

Please sign in to comment.