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.7.8.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

yoto_api-1.7.8-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yoto_api-1.7.8.tar.gz
  • Upload date:
  • Size: 18.8 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.7.8.tar.gz
Algorithm Hash digest
SHA256 142d8e501f509cb7f239d72190a94e8e3ba3f4685de6534a818a276428a2c2c9
MD5 ea233970551a876b239aa10e08fbb751
BLAKE2b-256 2d09f2655bdad91b21bbd44254c2c86decd3d3b69b5d14d28f7fcd313f0db06d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yoto_api-1.7.8-py3-none-any.whl
  • Upload date:
  • Size: 17.3 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.7.8-py3-none-any.whl
Algorithm Hash digest
SHA256 857abca7b72278c2708b9cde799589cef39ba2bfabc7f0ff93538beb8554177a
MD5 8dbab529783a10c5f80d739db77d2f95
BLAKE2b-256 bd3285f0b2a80ac21f1d062d9503237dfe605020fb842abe0814afabe6c7bcc4

See more details on using hashes here.

Supported by

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