PSDK

Interface Changes

✓ available, — not available. Interfaces not listed are identical on EVO Nest and Autel Nest2.

Method	Function	EVO Nest	Autel Nest2	Notes
`psdk_light_open`	Searchlight - Open	—	✓	Not documented for EVO Nest, which only lists `psdk_light_close`
`speaker_replay`	Speaker - Replay	—	✓

Speaker - Audio Playback Progress Notification

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: speaker_audio_play_start_progress

Data:

Column	Name	Type	constraint	Description
result	Result code	int	0 means success, non-0 means error. For details, see error codes	Return code, 0 indicates success
output	Output	struct		Output of the service execution
»psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
»status	Current stage	enum_string	{"in_progress":"In progress","ok":"Playback successful","canceled":"Canceled"}	Current playback stage
»md5	MD5 checksum of file content, used as dock unique identifier	text		File MD5 checksum
»progress	Progress	struct		Playback progress information
»»percent	Progress percentage	int	{"max":"100","min":"0","step":"1","unit_name":"Percentage / %"}	Current progress percentage
»»step_key	Current step	enum_string	{"download":"Download audio from cloud to dock","encoding":"Encode to Opus","upload":"Dock upload audio to PSDK","play":"Start playback"}	Current execution step identifier

Speaker - TTS Playback Progress Notification

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: speaker_tts_play_start_progress

Data:

Column	Name	Type	constraint	Description
result	Result code	int	0 means success, non-0 means error. For details, see error codes	Return code, 0 indicates success
output	Output	struct		Output of the service execution
»psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
»status	Current stage	enum_string	{"in_progress":"In progress","ok":"Playback successful","canceled":"Canceled"}	Current playback stage
»md5	MD5 checksum of file content, used as dock unique identifier	text		File MD5 checksum
»progress	Progress	struct		Playback progress information
»»percent	Progress percentage	int	{"max":"100","min":"0","step":"1","unit_name":"Percentage / %"}	Current progress percentage
»»step_key	Current step	enum_string	{"change_work_mode":"Switch work mode","upload":"Dock upload text to PSDK","play":"Start playback"}	Current execution step identifier

services

Not supported by the current firmware.

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_widget_value_set

Data:

Column	Name	Type	Description
psdk_index	PSDK payload device index	int	PSDK payload device index
index	Widget index	int	Widget number
value	Widget value	int	Widget value

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_widget_value_set

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Speaker - Start Audio Playback

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: speaker_audio_play_start

Data

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
file	Audio file	struct		Audio file information
»name	Filename	text		Audio file name
»url	File download URL	text		Audio file download URL
»md5	MD5 checksum of audio file, used as dock unique identifier	text		Audio file MD5 checksum
»format	Speaker input file format	enum_string	{"opus":"opus format","mp3":"mp3 format","wav":"wav format","flac":"flac format","aac":"aac format","m4a":"m4a format","wma":"wma format"}	Audio file format

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: speaker_audio_play_start

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Speaker - Start TTS Text Playback

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: speaker_tts_play_start

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
tts	TTS text	struct		TTS text information
»name	Filename	text		TTS file name, optional
»text	Text content	text		Broadcast text content, required
»md5	MD5 checksum of file content, used as dock unique identifier	text		File content MD5 checksum, optional
»speed	Broadcast speed	float	{"max":2.0,"min":0.5}	Broadcast speed, optional, defaults to 1.0; values out of range fall back to 1.0

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: speaker_tts_play_start

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Speaker - Replay

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: speaker_replay

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","data": {"psdk_index": 2},"method": "speaker_replay","tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","timestamp": 1689748815503}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: speaker_replay

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","data": {"result": 0},"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","timestamp": 1654070968655,"method": "speaker_replay"}

Speaker - Stop Playback

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: speaker_play_stop

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","data": {"psdk_index": 2},"method": "speaker_play_stop","tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","timestamp": 1689748815503}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: speaker_play_stop

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","data": {"result": 0},"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","timestamp": 1654070968655,"method": "speaker_play_stop"}

Speaker - Set Playback Mode

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: speaker_play_mode_set

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
play_mode	Speaker playback mode	enum_int	{"0":"Single play","1":"Loop play (single track)"}	Playback mode setting

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","data": {"play_mode": 1,"psdk_index": 2},"method": "speaker_play_mode_set","tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","timestamp": 1689842974113}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: speaker_play_mode_set

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","data": {"result": 0},"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","timestamp": 1654070968655,"method": "speaker_play_mode_set"}

Speaker - Set Volume

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: speaker_play_volume_set

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
play_volume	Speaker volume	int	{"max":100,"min":0,"step":1}	Speaker playback volume

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","data": {"play_volume": 13,"psdk_index": 2},"method": "speaker_play_volume_set","tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","timestamp": 1689842989237}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: speaker_play_volume_set

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Example:

{"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","data": {"result": 0},"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx","timestamp": 1654070968655,"method": "speaker_play_volume_set"}

Searchlight - Open

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_light_open

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_light_open

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Searchlight - Close

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_light_close

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_light_close

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Searchlight - Flash Mode Setting

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_set_flash_mode

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
light_flash_mode	Flash mode	enum_int	{"0":"Off","1":"Red light flash","2":"Red-blue light flash","3":"Blue light flash"}	Searchlight flash mode

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_set_flash_mode

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Searchlight - Set Brightness

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_light_set_brightness

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
light_brightness	Light brightness	enum_int	{"1":"Level 1 (33)","2":"Level 2 (66)","3":"Level 3 (99)"}	Searchlight brightness level

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_light_set_brightness

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Searchlight - Set Pitch Angle

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_light_set_pitch_angle

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index
light_pitch_angle	Pitch angle	int	{"max":30,"min":-90,"step":1}	Searchlight pitch angle

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_light_set_pitch_angle

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Searchlight - Enable Gimbal Linkage

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_open_light_ptz_linkage

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_open_light_ptz_linkage

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Searchlight - Disable Gimbal Linkage

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: psdk_close_light_ptz_linkage

Data:

Column	Name	Type	constraint	Description
psdk_index	PSDK payload device index	int	{"min":0}	PSDK payload device index

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: psdk_close_light_ptz_linkage

Data:

Column	Name	Type	constraint	Description
result	Result code	int		Return code, 0 indicates success

Interface Changes​

Speaker - Audio Playback Progress Notification​

Speaker - TTS Playback Progress Notification​

services

PSDK - Set Widget Value​

Speaker - Start Audio Playback​

Speaker - Start TTS Text Playback​

Speaker - Replay​

Speaker - Stop Playback​

Speaker - Set Playback Mode​

Speaker - Set Volume​

Searchlight - Open​

Searchlight - Close​

Searchlight - Flash Mode Setting​

Searchlight - Set Brightness​

Searchlight - Set Pitch Angle​

Searchlight - Enable Gimbal Linkage​

Searchlight - Disable Gimbal Linkage​

Interface Changes

Speaker - Audio Playback Progress Notification

Speaker - TTS Playback Progress Notification

PSDK - Set Widget Value

Speaker - Start Audio Playback

Speaker - Start TTS Text Playback

Speaker - Replay

Speaker - Stop Playback

Speaker - Set Playback Mode

Speaker - Set Volume

Searchlight - Open

Searchlight - Close

Searchlight - Flash Mode Setting

Searchlight - Set Brightness

Searchlight - Set Pitch Angle

Searchlight - Enable Gimbal Linkage

Searchlight - Disable Gimbal Linkage