Options
All
  • Public
  • Public/Protected
  • All
Menu

Default class exported by @sebbo2002/node-pyatv. Use find to scan for devices in your local network. Use device to connect to a known device by passing (at least) it's name and IP.

import pyatv from '@sebbo2002/node-pyatv';

Hierarchy

  • default

Index

Constructors

constructor

Methods

check

device

  • Create a [[NodePyATVDevice]] to query the state and control it. At least host and name are required.

    Parameters

    Returns default

find

  • Scan the network for Apple TVs by using pyatv's atvscript. See NodePyATVFindAndInstanceOptions for the options allowed. Use the host / hosts attribute to filter by IP addresses. Resolves with an array of [[NodePyATVDevice]].

    import pyatv from '@sebbo2002/node-pyatv';
    const myPyATV = new pyatv({debug: true});
    const devices = await myPyATV.find();
    console.log(devices);
    

    Parameters

    Returns Promise<default[]>

version

Static check

Static device

  • Create a [[NodePyATVDevice]] to query the state and control it. At least host and name are required.

    Parameters

    Returns default

Static find

  • Scan the network for Apple TVs by using pyatv's atvscript. See NodePyATVFindAndInstanceOptions for the options allowed. Use the host / hosts attribute to filter by IP addresses. Resolves with an array of [[NodePyATVDevice]].

    import pyatv from '@sebbo2002/node-pyatv';
    const devices = await pyatv.find();
    console.log(devices);
    

    Parameters

    Returns Promise<default[]>

Static version

Legend

  • Constructor
  • Method
  • Property
  • Static method

Generated using TypeDoc