API reference Manual

神之眼L提供了一组用于管理功能的restful API，实现了包含设备信息查询、播放列表更改、文件上传下载等功能。您可以依据该手册进行后台管理界面的二次开发。

The Vision L provides restful APIs for management purpose, implemented functions such as device info query, playlist update, file upload, etc. You may develop your own manage backend referencing this manual.

注意：所有API主机地址均为神之眼的ipv4地址

Note：The host of all APIs are the ipv4 address of the Vision.

基础信息 / Basic Info

GET /api/v1/info

Brief

该函数返回神之眼的基础信息，包含设备名、硬件版本、app版本信息。

This function resurns basic info of Vision, including device name, hardware version, app version, etc.

Example

GET /api/v1/info

RESPONSE:
{
    "device_name": "Vision_f768",
    "app_version": "L0.2.1",
    "hw_version": 1,
    "mac_address": "abcdef012345"
}

播放列表 / Play List

GET /api/v1/playlist

Brief

该函数返回神之眼当前应用的播放列表。

This function returns the playlist Vision currently using.

Example

GET /api/v1/playlist

RESPONSE:
{
    "files":[
        "S:/Pyro.mjpeg",
        "S:/Hydro.mjpeg",
        "S:/Anemo.mjpeg",
        "S:/Electro.mjpeg",
        "S:/Dendro.mjpeg",
        "S:/Cryo.mjpeg",
        "S:/Geo.mjpeg",
        "S:/Unowned.mjpeg"
    ]
}

POST /api/v1/playlist

Brief

该函数将更新播放列表。

This function will update the playlist.

Param

以JSON格式封装的新播放列表，包含在请求体中。

New playlist in JSON, included in request body.

Return

新的播放列表或者下列错误中的一个。

The new playlist or error among table below.

Description	Code
JSON deseralization error	-1
Invalid JSON	-2

Example

POST /api/v1/playlist
BODY:
{
    "files":[
        "S:/Pyro.mjpeg",
        "S:/Hydro.mjpeg",
        "S:/Anemo.mjpeg"
    ]
}

RESPONSE:
{
    "files":[
        "S:/Pyro.mjpeg",
        "S:/Hydro.mjpeg",
        "S:/Anemo.mjpeg"
    ]
}

GET /api/v1/playlist/current

Brief

该函数用于获取/设置当前播放文件编号。

This function is used to get/set current playback file.

Param

value: 要设置的文件(0-255)，应小于播放列表大小。获取值时uri中不要带有查询参数。

value: File to set(0-255), should be smaller than playlist size. DO NOT add any query params when getting this value.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/playlist/current?value=0

RESPONSE:
{
    "currFileId":0
}

文件管理 / File Management

GET /api/v1/file

Brief

该函数用于下载文件。

This function is for file downloads.

Param

path: 文件路径，以url形式传参。需要包含挂载路径。

path: File path, passed in url. Mount point should be included.

Response

Description	Code
Missing parameter	-1
Parameter too long	-2
Unable to open file	-3
No such volume	-5
File not exist	-6
Failed on sending file	-11
No enough ram to create buffer	-20

Example

GET /api/v1/file?path=/s/Geo.mjpeg

RESPONSE:
[Geo.mjpeg]

POST /api/v1/file

Brief

该函数用于上传文件。

This function is for file uploads.

Param

path: 文件路径，以url形式传参。需要包含挂载路径。

path: File path, passed in url. Mount point should be included.

Response

Description	Code
Success	0
Missing parameter	-1
Parameter too long	-2
Unable to open file	-3
No such volume	-5
Unable to open (create) file	-8
Failed on receiving file	-9
Failed on writing file	-10
No enough ram to create buffer	-20

Example

GET /api/v1/file?path=/s/Geo.mjpeg
BODY:
[Geo.mjpeg]

RESPONSE:
{
    "response": "success",
    "code": 0
}

DELETE /api/v1/file

Brief

该函数用于删除文件/文件夹。

This function is for file (directory) delection.

Param

path: 文件路径，以url形式传参。需要包含挂载路径。

path: File path, passed in url. Mount point should be included.

Response

Description	Code
Success	0
Missing parameter	-1
Parameter too long	-2
Error occured deleting files	-4
No such volume	-5

Example

DELETE /api/v1/file?path=/s/冰.mjpeg

RESPONSE:
{
    "response": "success",
    "code": 0
}

MOVE /api/v1/file

Brief

该函数用于移动或重命名文件/文件夹。

This function is to move/rename file (directory).

Param

path1: 原文件路径，以url形式传参。需要包含挂载路径。

path2: 新文件路径，以url形式传参。需要包含挂载路径。

path1: Original file path, passed in url. Mount point should be included.

path2: New file path, passed in url. Mount point should be included.

Response

Description	Code
Success	0
Missing parameter	-1
Parameter too long	-2
No such volume	-5
File not exist	-6

Example

MOVE /api/v1/file?path1=/s/冰.mjpeg&path2=/s/Cryo.mjpeg

RESPONSE:
{
    "response": "success",
    "code": 0
}

COPY /api/v1/file

Brief

该函数用于复制文件。

This function is to copy file.

Param

path1: 原文件路径，以url形式传参。需要包含挂载路径。

path2: 新文件路径，以url形式传参。需要包含挂载路径。

path1: Original file path, passed in url. Mount point should be included.

path2: New file path, passed in url. Mount point should be included.

Response

Description	Code
Success	0
Missing parameter	-1
Parameter too long	-2
No such volume	-5
File not exist	-6
Unable to copy file	-8

Example

COPY /api/v1/file?path1=/s/冰.mjpeg&path2=/s/冰(1).mjpeg

RESPONSE:
{
    "response": "success",
    "code": 0
}

GET /api/v1/file/listdir

Brief

该函数用于读取文件夹。

This function is to read directory.

Param

path: 文件夹路径，以url形式传参。需要包含挂载路径。

path: Directory path, passed in url. Mount point should be included.

Response

JSON封装的文件列表，包含文件名、文件大小及最后修改时间。文件夹以'/'开头。

File list in JSON, includes file name, size, and last modification time. Directories starts witl '/'.

Description	Code
Missing parameter	-1
Parameter too long	-2
Unable to open path	-3
No such volume	-5

Example

GET /api/v1/file/listdir?path=/s/

RESPONSE:
{
    "files":[
        ["/The Vision L",0,1672554818],
        ["Anemo.mjpeg",21092500,1661271210],
        ["Cryo.mjpeg",14406262,1661270150],
        ["NRE.wav",265300,1648278648],
        ["playFiles.json",243,1664634200],
        ["岩.mjpeg",14581853,1661270304]
    ]
}

POST /api/v1/file/makedir

Brief

该函数用于新建文件夹。

This function is to create a directory.

注意：一次只能创建一级文件夹

Note: mkdir could only create one level of directory at once

Param

path: 文件夹路径，以url形式传参。需要包含挂载路径。

path: Directory path, passed in url. Mount point should be included.

Return

Description	Code
Success	0
Missing parameter	-1
Parameter too long	-2
No such volume	-5
Path already exists	-7
Unable to create directory	-8

Example

POST /api/v1/file/makedir?path=/s/新建文件夹

RESPONSE:
{
    "response": "success",
    "code": 0
}

米游社配置 / Hoyolab Configurations

GET /api/v1/hoyolab/conf

Brief

该函数用于获取当前米游社配置。

This function is to get current Hoyolab configurations.

Return

JSON封装的米游社配置，包含角色uid，登陆cookie及设备guid。

Hoyolab configuration packed in JSON, including character uid, cookie for login, and device guid.

Example

GET /api/v1/hoyolab/conf

RESPONSE:
{
    "uid":"012345678",
    "cookie":"HOYOLAB_COOKIE",
    "device_guid":"0123456789abcdef0123456789abcdef"
}

POST /api/v1/hoyolab/conf

Brief

该函数用于设置米游社配置。

This function is to set Hoyolab configurations.

Param

JSON封装的米游社配置，包含角色uid，登陆cookie及设备guid。

注意：三个配置值均是必填项，API将直接从JSON中读取值并覆盖，不会进行校验

Hoyolab configuration packed in JSON, including character uid, cookie for login, and device guid.

Note: All the three values are required, the API does not do any validations, just simply overwrite.

Return

Description	Code
success	0
Error when deserializing json	-1
Invalid JSON	-2

Example

POST /api/v1/hoyolab/conf
BODY:
{
    "uid":"012345678",
    "cookie":"HOYOLAB_COOKIE",
    "device_guid":"0123456789abcdef0123456789abcdef"
}

RESPONSE:
{
    "response":"success",
    "code":0
}

设备设置 / Device Settings

GET /api/v1/setting/auto_bright

Brief

该函数用于获取或设置自动亮度开关。

This function is to get or set value of auto brightness.

Param

value: 要设置的值，"true"或"false"中的一个。获取值时uri中不要带有查询参数。

value: Value to set, should be one of "true" or "false". DO NOT add any query params when getting this value.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/auto_bright?value=false

RESPONSE:
{
    "setting_autoBright":false
}

GET /api/v1/setting/auto_rotate

Brief

该函数用于获取或设置自动旋转开关。

This function is to get or set value of auto rotation.

Param

value: 要设置的值，"true"或"false"中的一个。获取值时uri中不要带有查询参数。

value: Value to set, should be one of "true" or "false". DO NOT add any query params when getting this value.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/auto_rotate?value=false

RESPONSE:
{
    "setting_useAccel":false
}

GET /api/v1/setting/brightness

Brief

该函数用于获取或设置屏幕亮度。启用自动亮度时调整该值不会引起屏幕亮度变化。

This function is to get or set screen brightness. This will not override auto brightness setting.

Param

value: 要设置的值(1-255)。获取值时uri中不要带有查询参数。

value: Value to set(1-255). DO NOT add any query params when getting this value.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/brightness?value=127

RESPONSE:
{
    "setting_screenBrightness":127
}

GET /api/v1/setting/language

Brief

该函数用于获取或设置设备语言。

This function is to get or set device language.

Param

value: 要设置的值，下方语言代码表中的一个。获取值时uri中不要带有查询参数。

value: Value to set, should be one of codes bwlow. DO NOT add any query params when getting this value.

Lanauge	Code
English	0
简体中文	1

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/language?value=0

RESPONSE:
{
    "curr_lang":0
}

GET /api/v1/setting/timezone

Brief

该函数用于获取或设置设备时区。

This function is to get or set device timezone.

Param

value: 要设置的值(POSIX)。获取值时uri中不要带有查询参数。

注意：该值将直接覆盖环境变量，不会受到任何检查。

注意：该值与常见时区格式不同，时区代码后的数字代表比该时区慢X小时。例如，UTC-8代表比世界协调时慢-8小时，即快8小时，实为UTC+8:00。

value: Value to set (POSIX). DO NOT add any query params when getting this value.

Note: The value will override TZ environment variable directly without any inspection.

Note: This value is different from the common time zone format, the number after the time zone code represents X hours behind the time zone. For example, UTC-8 means -8 hours behind UTC, that is, 8 hours ahead, which is actually UTC+8:00.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/timezone?value=UTC-8

RESPONSE:
{
    "setting_timeZone":"UTC-8"
}

GET /api/v1/setting/time

Brief

该函数用于获取或设置设备时间。

This function is to get or set time.

Param

value: 要设置的值，秒级时间戳。获取值时uri中不要带有查询参数。

value: Value to set, timestamp in seconds. DO NOT add any query params when getting this value.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/time?value=1676102473

RESPONSE:
{
    "device_time":1676102473
}

GET /api/v1/setting/auto_update

Brief

该函数用于获取或设置自动更新开关。

This function is to get or set device autoupdate switch.

Param

value: 要设置的值，"true"或"false"中的一个。获取值时uri中不要带有查询参数。

value: Value to set, should be one of "true" or "false". DO NOT add any query params when getting this value.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/auto_update?value=true

RESPONSE:
{
    "setting_autoUpdate":1
}

GET /api/v1/setting/update_channel

Brief

该函数用于获取或设置设备自动更新渠道。

This function is to get or set device autoupdate channel.

Param

value: 要设置的值，下方语言代码表中的一个。获取值时uri中不要带有查询参数。

value: Value to set, should be one of codes bwlow. DO NOT add any query params when getting this value.

Channel	Code
Stable 稳定版	0
Beta 测试版	1

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/update_channel?value=0

RESPONSE:
{
    "setting_updateChannel":0
}

GET /api/v1/setting/default_screen

Brief

该函数用于获取或设置设备启动后界面。

This function is to get or set default screen.

Param

value: 要设置的值，下方语言代码表中的一个。获取值时uri中不要带有查询参数。

value: Value to set, should be one of codes bwlow. DO NOT add any query params when getting this value.

Screen	Code
Menu 主菜单	0
Vision 神之眼	1
Resin 树脂	2
Clock 主题时钟	3

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/setting/default_screen?value=0

RESPONSE:
{
    "setting_defaultScreen":0
}

天气配置 / Weather Configurations

GET /api/v1/weather/city

Brief

该函数用于获取或设置城市及天气源。

This function is to get or set city and weather provider for weather service.

Param

param	description	format
city	城市名称 / city name	string
latitude	纬度 / latitude	float, [-90 ~ 90]
langitude	经度 / langitude	float, [-180 ~ 180]
provider	天气提供商 / weather provider	int, 0 = OpenMeteo

墨迹天气自2023粘2月10日起不可用。请将天气提供商值设为0.
Mojitianqi is no longer avaliable since Feb 10, 2023. Please set provider to 0.

Return

当前设置值，或更新后的设置值（若有）。

The current setting value, or the updated setting value (if set a new one).

或者下列错误代码中的一个：

or error among table below:

Description	Code
Invalid value	-2

Example

GET /api/v1/weather/city?city=深圳&latitude=22.54554&longitude=114.0683

RESPONSE:
{
    "city":"深圳",
    "latitude":22.545540,
    "longitude":114.068298,
    "provider":1
}

FilesExpand file tree

apiReference.md

Latest commit

History

apiReference.md

File metadata and controls

API reference Manual

基础信息 / Basic Info

GET /api/v1/info

Brief

Example

播放列表 / Play List

GET /api/v1/playlist

Brief

Example

POST /api/v1/playlist

Brief

Param

Return

Example

GET /api/v1/playlist/current

Brief

Param

Return

Example

文件管理 / File Management

GET /api/v1/file

Brief

Param

Response

Example

POST /api/v1/file

Brief

Param

Response

Example

DELETE /api/v1/file

Brief

Param

Response

Example

MOVE /api/v1/file

Brief

Param

Response

Example

COPY /api/v1/file

Brief

Param

Response

Example

GET /api/v1/file/listdir

Brief

Param

Response

Example

POST /api/v1/file/makedir

Brief

Param

Return

Example

米游社配置 / Hoyolab Configurations

GET /api/v1/hoyolab/conf

Brief

Return

Example

POST /api/v1/hoyolab/conf

Brief

Param

Return

Example

设备设置 / Device Settings

GET /api/v1/setting/auto_bright

Brief

Param

Return

Example

GET /api/v1/setting/auto_rotate

Brief

Param