npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-atv

v1.0.2

Published

A lightweight wrapper around pyatv…

Downloads

70

Readme

node-pyatv

License Unit Tests

A lightweight wrapper around pyatv's which also supports realtime notifications.

📝 Content

☁ Installation

Before you use node-pyatv you need to install pyatv. This module woun't do this for you. Run atvremote --version to double check your installation. See FAQ section for installation tips.

To install the javascript module via npm just run:

npm install @sebbo2002/node-pyatv

⚒ Quick Start

import pyatv, {NodePyATVDeviceEvent} from '@sebbo2002/node-pyatv';

const devices = await pyatv.find(/*{debug: true}*/);
if (!devices.length) {
    throw new Error('Oh no.');
}

const device = devices[0];

// request current title
console.log(await device.getTitle());

// request full state
console.log(await device.getState());

// subscribe to events
device.on('update:deviceState', (event: NodePyATVDeviceEvent | Error) => {
    if(event instanceof Error) return;
    console.log(`Current device state is ${event.value}`);
});

📑 API Reference

The API documentation is automatically generated from the code comments and can be found here.

📑 Changelog

Please have a look at CHANGELOG.md to see the changelog.

🤨 FAQ

How to install pyatv

pip3 install pyatv

How to debug things

You can pass "debug": true for any command called. Some debug information is then printed via console.log. Additionaly you can pass a function to process debugs logs.

Why are some tests skipped?

Some unit tests require a responding apple tv to pass. These tests are disabled by default. You can set the environment variable ENABLE_INTEGRATION=1 to enable them.

Is this secure?

Defenitely not. For example, there's no escaping for parameters passed to pyatv. So be sure to double check the data you pass to this library, otherwise it may be possible to run code on your machine.

Copyright and license

Copyright (c) Sebastian Pekarek under the MIT license.