get device status

Request Description

This endpoint retrieves the current status of a specific device identified by deviceId. It provides various metrics and indicators about the device's state, including connectivity, battery level, and sensor readings.

Response Body

The response contains detailed information about the status of the device, including the following fields:

• activeCard: Indicates the active card on the device.

• ambientLightSensorReading: Provides the reading from the ambient light sensor.

• averageDownloadSpeedBytesSecond: Indicates the average download speed in bytes per second.

• batteryLevelPercentage: Represents the battery level in percentage.

• cardInsertionState: Indicates the state of card insertion. 0 is no inserted card, 1 is a physical card, and 2 is a remote card play

• dayMode: Indicates the day mode status. -1 is unknown, 0 is night, 1 is day

• deviceId: Represents the unique identifier of the device.

• freeDiskSpaceBytes: Represents the amount of free disk space in bytes.

• isAudioDeviceConnected: Indicates whether an audio device is connected to the device.

• isBackgroundDownloadActive: Indicates if background download is active.

• isBluetoothAudioConnected: Indicates if Bluetooth audio is connected.

• isCharging: Indicates if the device is currently charging.

• isOnline: Indicates if the device is currently online.

• networkSsid: Represents the network SSID the device is connected to.

• nightlightMode: Indicates the nightlight mode status. Either a hex code or off

• powerSource: Indicates the power source of the device. 0=battery only, 1=V2 dock, 2=USB-C, 3=Qi dock

• systemVolumePercentage: Represents the system volume in percentage.

• temperatureCelcius: Provides the temperature in Celsius.

• totalDiskSpaceBytes: Represents the total disk space in bytes.

• updatedAt: Indicates the timestamp of the last update.

• uptime: Represents the uptime of the device.

• userVolumePercentage: Represents the user volume in percentage.

• utcOffsetSeconds: Provides the UTC offset in seconds.

• utcTime: Indicates the UTC time.

• wifiStrength: Represents the strength of the WiFi connection in decibels.

Responses

200

200 ok application/json

Schema

deviceIdstring

updatedAtstring

JSON

{
  "deviceId": "t21KFoWYO48DwzXPIo7ObZ7U",
  "updatedAt": "2024-04-30T16:51:06.128Z"
}

Path Parameters

deviceId string Required

GET

/device-v2/{deviceId}/status

Server URL: https://api.yotoplay.com

Authorization (bearerAuth)

Token

Try it out

cURL

curl "https://api.yotoplay.com/device-v2/{deviceId}/status"
--header "Authorization: Bearer [YOUR_TOKEN]"

JavaScript

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer [YOUR_TOKEN]'
  }
};

fetch('https://api.yotoplay.com/device-v2/{deviceId}/status', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yotoplay.com/device-v2/{deviceId}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer [YOUR_TOKEN]"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.yotoplay.com/device-v2/{deviceId}/status"

headers = {
    "Authorization": "Bearer [YOUR_TOKEN]"
}

response = requests.request("GET", url, headers=headers)

print(response.text)