homeassistant.components.roon.server.RoonServer Class Reference

Public Member Functions
def	__init__ (self, hass, config_entry)
def	add_player_id (self, entity_id, roon_name)
def	async_create_player_data (self, zone, output)
def	async_do_loop (self)
def	async_reset (self)
def	async_setup (self, tries=0)
def	async_update_changed_players (self, changed_zones_ids)
def	async_update_players (self)
def	entity_id (self, roon_name)
def	roon_name (self, entity_id)
def	roonapi_state_callback (self, event, changed_zones)
def	stop_roon (self)
def	zones (self)

Public Attributes
	all_player_ids
	all_playlists
	config_entry
	hass
	offline_devices
	roon_id
	roonapi

Private Attributes
	_exit
	_id_by_roon_name
	_roon_name_by_id

Detailed Description

Manages a single Roon Server.

Definition at line 19 of file server.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.roon.server.RoonServer.__init__	(		self,
			hass,
			config_entry
	)

Initialize the system.

Definition at line 22 of file server.py.

Member Function Documentation

add_player_id()

def homeassistant.components.roon.server.RoonServer.add_player_id	(		self,
			entity_id,
			roon_name
	)

Register a roon player.

Definition at line 90 of file server.py.

async_create_player_data()

def homeassistant.components.roon.server.RoonServer.async_create_player_data	(		self,
			zone,
			output
	)

Create player object dict by combining zone with output.

Definition at line 163 of file server.py.

async_do_loop()

def homeassistant.components.roon.server.RoonServer.async_do_loop

(

self

)

Background work loop.

Definition at line 112 of file server.py.

async_reset()

def homeassistant.components.roon.server.RoonServer.async_reset

(

self

)

Reset this connection to default state.

Will cancel any scheduled setup retry and will unload
the config entry.

Definition at line 76 of file server.py.

async_setup()

def homeassistant.components.roon.server.RoonServer.async_setup	(		self,
			tries = 0
	)

Set up a roon server based on config parameters.

Definition at line 35 of file server.py.

async_update_changed_players()

def homeassistant.components.roon.server.RoonServer.async_update_changed_players	(		self,
			changed_zones_ids
	)

Update the players which were reported as changed by the Roon API.

Definition at line 120 of file server.py.

async_update_players()

def homeassistant.components.roon.server.RoonServer.async_update_players

(

self

)

Periodic full scan of all devices.

Definition at line 142 of file server.py.

entity_id()

def homeassistant.components.roon.server.RoonServer.entity_id	(		self,
			roon_name
	)

Get the id of the roon player from the roon name.

Definition at line 99 of file server.py.

roon_name()

def homeassistant.components.roon.server.RoonServer.roon_name	(		self,
			entity_id
	)

Get the name of the roon player from entity_id.

Definition at line 95 of file server.py.

roonapi_state_callback()

def homeassistant.components.roon.server.RoonServer.roonapi_state_callback	(		self,
			event,
			changed_zones
	)

Callbacks from the roon api websocket with state change.

Definition at line 108 of file server.py.

stop_roon()

def homeassistant.components.roon.server.RoonServer.stop_roon

(

self

)

Stop background worker.

Definition at line 103 of file server.py.

zones()

def homeassistant.components.roon.server.RoonServer.zones

(

self

)

Return list of zones.

Definition at line 86 of file server.py.

Member Data Documentation

_exit

homeassistant.components.roon.server.RoonServer._exit

private

Definition at line 31 of file server.py.

_id_by_roon_name

homeassistant.components.roon.server.RoonServer._id_by_roon_name

private

Definition at line 33 of file server.py.

_roon_name_by_id

homeassistant.components.roon.server.RoonServer._roon_name_by_id

private

Definition at line 32 of file server.py.

all_player_ids

homeassistant.components.roon.server.RoonServer.all_player_ids

Definition at line 28 of file server.py.

all_playlists

homeassistant.components.roon.server.RoonServer.all_playlists

Definition at line 29 of file server.py.

config_entry

homeassistant.components.roon.server.RoonServer.config_entry

Definition at line 24 of file server.py.

hass

homeassistant.components.roon.server.RoonServer.hass

Definition at line 25 of file server.py.

offline_devices

homeassistant.components.roon.server.RoonServer.offline_devices

Definition at line 30 of file server.py.

roon_id

homeassistant.components.roon.server.RoonServer.roon_id

Definition at line 27 of file server.py.

roonapi

homeassistant.components.roon.server.RoonServer.roonapi

Definition at line 26 of file server.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/roon/server.py