Skip to main content

A python package that makes it a bit easier to work with the yoto play API. Not associated with Yoto in any way.

Project description

Introduction

Early days of this API. Plan is to use this for home assistant. So far basic device data comes back including online. The library of cards is also populated. Pause command functions. Not other commands work yet.

Credit

A big thank you to @buzzeddesign for helping to sniff some of the API and make sense of it. Thank you to @fuatakgun for creating to core architecture is based on over in kia_uvo

Example Test Code

To run this code for test I am doing:

from pathlib import Path
import logging
import sys
import os

path_root = r"C:path to files GitHub\main\yoto_api"
sys.path.append(str(path_root))
from yoto_api import *

logging.basicConfig(stream=sys.stdout, level=logging.DEBUG, format='%(asctime)s %(name)s %(levelname)s:%(message)s')
logger = logging.getLogger(__name__)

ym = YotoManager(username="username", password="password")
ym.check_and_refresh_token()
ym.update_player_status()
print (ym.players)
ym.connect_to_events()
# Pauses the first player
ym.pause_player(next(iter(ym.players)))
# Sleep will let the terminal show events coming back. For dev today.
time.sleep(60)

Usage

Check and refresh token will pull the first set of data. It also should be run regularly if you keep your code running for days. It will check if the token is valid. If it isn’t it will refresh the token. If this is first run of the command and no data has been pulled it will also run update_player_status() and update_cards() for you.

ym.check_and_refresh_token()

Check and refresh token will pull the first set of data. It also should be run regularly if you keep your code running for days. It will check if the token is valid. If it isn’t it will refresh the token. If this is first run of the command and no data has been pulled it will also run update_player_status() and update_cards() for you.

ym.update_player_status()

Connects to the MQTT broker. This must be run before any command and also get get useful data.

ym.connect_to_events()

Pauses the player for the player ID sent. ID can be found in ym.players.keys()

ym.pause_player(player_id: str)

Updates the library of cards. This is done as part of check_refresh_token so only needed if data is stale.

ym.update_cards()

Contains player object will data values you can access.

ym.players

Contains the library of cards. Each card being an object with the data values you can use.

ym.library

Other Notes

This is not associated or affiliated with yoto play in any way.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yoto_api-1.11.7.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

yoto_api-1.11.7-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file yoto_api-1.11.7.tar.gz.

File metadata

  • Download URL: yoto_api-1.11.7.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for yoto_api-1.11.7.tar.gz
Algorithm Hash digest
SHA256 23cca2e545bf4ac8286f41bfac8ce515319fac8a0aebbb99235ee07fbb17dd79
MD5 0f02bb96d4b10ae9c209b0f8ecba03b0
BLAKE2b-256 ddb15e277abf087199ea747c3ee0873a1acbe095ba5cb9e39f6b8bd29da384e3

See more details on using hashes here.

File details

Details for the file yoto_api-1.11.7-py3-none-any.whl.

File metadata

  • Download URL: yoto_api-1.11.7-py3-none-any.whl
  • Upload date:
  • Size: 19.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for yoto_api-1.11.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2d94072cfba079cffbc95a2eb7a737de13db37e386065684d2f711ea8f92c5a6
MD5 bd25dd4efbd3bbfcc46d9e8b6ff90a5f
BLAKE2b-256 5f7a82d0a2cfeb5f02f44b9db70e88e1cdbd634a1fb689824d335fd2ef6d6219

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page