IDS NXT User Manual

March 2021 2
IDS NXT: REST interface
Contents
1 Preface .............................................................................................................................................. 5
2 Symbols and hints ............................................................................................................................ 6
3 Introduction ...................................................................................................................................... 7
3.1 Version hint ................................................................................................................................. 7
3.2 User authentication ...................................................................................................................... 7
3.3 Units ........................................................................................................................................... 7
3.4 Types ......................................................................................................................................... 7
3.5 Implemented services ................................................................................................................... 8
4 User control ...................................................................................................................................... 9
4.1 /users ......................................................................................................................................... 9
4.2 /users/<existing-username> .......................................................................................................... 9
5 Device events .................................................................................................................................. 11
5.1 /events ...................................................................................................................................... 11
5.2 Server sent events ..................................................................................................................... 12
5.3 Event syntax .............................................................................................................................. 12
5.4 Restrictions ............................................................................................................................... 12
6 Device information .......................................................................................................................... 13
6.1 /deviceinfo ................................................................................................................................ 13
6.2 /deviceinfo/avatar ....................................................................................................................... 16
6.3 /deviceinfo/datetime ................................................................................................................... 17
7 GPIO ............................................................................................................................................... 19
7.1 /gpio ......................................................................................................................................... 19
7.2 /gpio/inputs ............................................................................................................................... 19
7.3 /gpio/inputs/<pin> ...................................................................................................................... 19
7.4 /gpio/outputs .............................................................................................................................. 20
7.5 /gpio/outputs/<pin> .................................................................................................................... 20
8 Camera settings .............................................................................................................................. 22
8.1 /camera .................................................................................................................................... 22
8.2 /camera/trigger .......................................................................................................................... 24
8.3 /camera/image .......................................................................................................................... 27
8.4 /camera/roi ............................................................................................................................... 27
8.5 /camera/color ............................................................................................................................ 28

IDS NXT Specifications

General

Brand	IDS
Model	NXT
Category	Accessories
Language	English