WiiM HTTP API Docs
Search K

Appearance

Device control​

Control the device

Reboot​

GET
/reboot

http://10.10.10.254/httpapi.asp?command=reboot

JSON Response:
{"status":"OK"}

Responses​

Default response

text/html
JSON
{
  
"status": "OK"
}

Playground​

Samples​

Shutdown​

GET
/setShutdown:{sec}

http://10.10.10.254/httpapi.asp?command=setShutdown:sec

Shutdown device in sec

sec:
0: shutdown immediately
-1: cancel the previous shutdown timer

Parameters​

Path Parameters

sec*

Shutdown device in sec

0: shutdown immediately
-1: cancel the previous shutdown timer

Type
string
Required
Default
"0"

Responses​

Default response

text/html
JSON
{
  
"status": "OK"
}

Playground​

Variables
Key
Value

Samples​

Get the shutdown timer​

GET
/getShutdown

http://10.10.10.254/httpapi.asp?command=getShutdown

Return the seconds

Responses​

Default response

text/html

Playground​

Samples​

Turn on/off status LED ("Status Light" option from app)​

GET
/LED_SWITCH_SET:{n}

Example: https://10.10.10.254/httpapi.asp?command=LED_SWITCH_SET:0

Observations:

  • Value is either 1 (on) or 0 (off)

Parameters​

Path Parameters

n*

1 (on) or 0 (off)

Type
integer
Required
Valid values
01
Default
1

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Turn on/off touch controls​

GET
/Button_Enable_SET:{n}

Example: https://10.10.10.254/httpapi.asp?command=Button_Enable_SET:0

Observations:

  • Value is either 1 (on) or 0 (off)

Parameters​

Path Parameters

n*

1 (on) or 0 (off)

Type
integer
Required
Valid values
01
Default
1

Responses​

Successful response

text/html
JSON
"OK"

Playground​

Variables
Key
Value

Samples​

Get button enable status​

GET
/Button_Enable_GET

...

Responses​

Successful response

Playground​

Samples​

Get firmware version​

GET
/getFirmwareVersion

...

Responses​

Successful response

Playground​

Samples​

Get device name changeable status​

GET
/getDeviceNameChangeable

...

Responses​

Successful response

Playground​

Samples​

Restoring the factory setting​

GET
/restoreToDefault

Example: http://10.10.10.254/httpapi.asp?command=restoreToDefault

To restore factory settings, erasing defined configurations. The device restarts.

Responses​

Successful response

Playground​

Samples​

Setting the name of device​

GET
/setDeviceName:{name}

Example: http://10.10.10.254/httpapi.asp?command=setDeviceName:%s

Sets the name UPnP, DLNA and Airplay of the device (Hex)

Parameters​

Path Parameters

name*

The new device name to set for UPnP, DLNA, and Airplay, in hexadecimal format.

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Get system log​

GET
/getsyslog

...

Responses​

Successful response

Playground​

Samples​

Set hex device name​

GET
/setHexDeviceName:{str}

...

Parameters​

Path Parameters

str*

Unknown

Type
string
Required

Responses​

Successful response

Playground​

Variables
Key
Value

Samples​

Disable sending more device events​

GET
/noSendMoreDeviceEvent:1

...

Responses​

Successful response

Playground​

Samples​

Get hardware error information​

GET
/getHwErrorInfo

...

Returns: { "ethError": 0, "mfiChipError": 0, "flashSpaceError": 0, "badBlockNum": 3, "totalBlockNum": 2000, "hdmiError": 0, "temperatureSensorError": 0, "ledError": 0, "soundCardHwError": { "es9018": 0, "pcm5121": 0 } }

Responses​

Successful response

application/json
JSON
{
  
"ethError": 0,
  
"mfiChipError": 0,
  
"flashSpaceError": 0,
  
"badBlockNum": 3,
  
"totalBlockNum": 2000,
  
"hdmiError": 0,
  
"temperatureSensorError": 0,
  
"ledError": 0,
  
"soundCardHwError": {
  
  
"es9018": 0,
  
  
"pcm5121": 0
  
}
}

Playground​

Samples​

Powered by VitePress OpenAPI