Start | Scan, Pair and Connect | Device Information | Control | Power Management | Features | Metadata | Listeners | Stream | Apps | Audio | Logging | Examples

Scan, Pair and Connect

Finding a device, pairing with it and connecting to it are the basic actions needed to control a device.

Scanning

API

async def scan(loop, timeout=5, identifier=None, protocol=None, hosts=None):

loop: asyncio event loop (e.g. asyncio.get_event_loop())

timeout: how long to scan (in seconds) before returning results

identifier: filter to scan for one particular device

protocol: filter for devices with a particular protocol (one from const.Protocol)

hosts: list of hosts to specifically scan for, e.g. ['10.0.0.1', '10.0.0.2']

Usage

Scanning for and printing name and address of all devices can be done like this:

atvs = await pyatv.scan(loop)
for atv in atvs:
    print(f"Name: {atv.name}, Address: {atv.address}")

You can put some limitations on what device(s) to scan for, e.g. an identifier and/or a protocol:

from pyatv import scan
from pyatv.const import Protocol

# Scan for a specific device
atvs = scan(loop, identifier='AA:BB:CC:DD:EE:FF')

# Scan for a specific device by IP (unicast)
atvs = scan(loop, hosts=['10.0.0.1'])

# Only scan for MRP capable devices
atvs = scan(loop, protocol=Protocol.MRP)

A list is always returned, even if a filter is applied. See conf.AppleTV for what you can do with a configuration (e.g. extract deep sleep state or available services).

Pairing

API

async def pair(config, protocol, loop, session=None, **kwargs):

config: configuration for the device of interest

protocol: which protocol to pair (service configuration must exist for this protocol)

loop: asyncio event loop (e.g. asyncio.get_event_loop())

session: optional aiohtttp.ClientSession (pyatv will create a new if not provided)

kwargs: optional arguments to pairing handler (see specific chapter)

Usage

Calling pyatv.pair returns a pairing handler conforming to the interface interface.PairingHandler. The usage flow is generic in order to support protocols that either require a PIN entered on the device (DMAP) or in the client (MRP and AirPlay). It looks like this:

  1. Start pairing by calling begin
  2. Check if device presents a PIN by checking device_provides_pin
    • If True: call pin with the PIN shown on screen
    • If False: call pin with the PIN that must be entered on the device
  3. Call finish
  4. Check if pairing succeeded with has_paired
  5. Free resources with close
  6. Obtained credentials are available via the service, i.e. service.credentials

In a future revision of this API, a function will be added that waits for the pairing to succeed (or timeout), in order to know when to call finish. This is only applicable to the case when device_provides_pin is False. Now you have to poll has_paired or just require that pairing succeeds within a time frame.

If an error occurs, e.g. incorrect PIN, exceptions.PairingError is raised.

Translating the flow above into code looks like this (this is a simplified version of examples/pairing.py):

from pyatv import scan, pair
from pyatv.const import Protocol

atvs = await scan(loop)

pairing = await pair(atvs[0], Protocol.MRP, loop)
await pairing.begin()

pin = int(input("Enter PIN: "))
pairing.pin(pin)
await pairing.finish()

# Give some feedback about the process
if pairing.has_paired:
    print('Paired with device!')
    print('Credentials:', pairing.service.credentials)
else:
    print('Did not pair with device!')

await pairing.close()

Storing credentials

Credentials are not stored persistently by pyatv. It is up to the developer to implement a solution for that. After pairing, make sure to save at least one identifier and credentials for all services somewhere:

identifier = const.identfier

# Save identifier

for service in config.services:
    protocol = service.protocol
    credentials = service.credentials

    # Save mapping of protocol and credentials

How to restore credentials is described in here.

MRP specifics

This protocol does not support any additional settings.

DMAP specifics

The following extra settings are supported by DMAP:

Setting Value
name Name of the device that is exposed on the network (what you see on your Apple TV).
pairing_guid Custom value for pairing_guid (credentials) with format 0xXXXXXXXXXXXXXXXX.
zeroconf If you want to use a custom zeroconf.Zeroconf instance, you can pass it here.

You pass these via kwargs to pyatv.pair:

pairing = await pyatv.pair(config, Protocol.DMAP, name='my remote')

AirPlay specifics

This protocol does not support any additional settings.

Companion specifics

This protocol does not support any additional settings.

RAOP specifics

This protocol does not support any additional settings.

Connecting

API

async def connect(config, loop, protocol=None, session=None):

config: configuration for the device of interest

loop: asyncio event loop (e.g. asyncio.get_event_loop())

protocol: override which protocol to use (DEPRECATED: not used in 0.8.0 and later)

session: optional aiohtttp.ClientSession (pyatv will create a new if not provided)

Usage

Connecting is simply done by passing a config to pyatv.conncet:

# Get a configuration with scan
atvs = await pyatv.scan(...)

# Apple TV configuration (first found device in this case)
conf = atvs[0]

# Connect with obtained configuration
atv = await pyatv.connect(atvs[0], loop)

If the configuration contains no services (only possible when manually creating a config), a exceptions.NoServiceError will be raised. The configuration must have an identifier, otherwise exceptions.DeviceIdMissingError will be raised.

If you have previously stored any credentials, you can need to load them again before connecting, see next chapter.

Note: Prior to version 0.8.0, the protocol argument specified which “main” protocol to use. This is no longer needed as the most appropriate protocol will be used automatically.

Restoring credentials

Restoring credentials is performed with conf.AppleTV.set_credentials:

# Restored from file
identifier = '...'
stored_credentials = {Protocol.MRP: 'xxx'}

# Find device and restore credentials
atvs = pyatv.scan(loop, identifier=identifier)

# Error handling here

atv = atvs[0]
for protocol, credentials in stored_credentials.items():
    atv.set_credentials(protocol, credentials)

True is returned if credentials were set, otherwise False.

Manual configuration

It is possible to bypass the scanning process and manually create a configuration:

config = conf.AppleTV('10.0.0.10', 'Living Room')
config.add_service(conf.DmapService('identifier', '0x123456789ABCDEF0')
atv = await pyatv.connect(config, loop)

Please do note that this is not the recommended way as it has a couple of flaws:

It can however be convenient to have if you test things when developing pyatv as you can shorten the feedback loop, since scanning can be avoided. But be warned.

← Start | Device Information →