R2D2 HTTP API

From Ultiroam User Docs
Jump to navigation Jump to search

Any command from the R2D2 API can be accessed through a HTTP Interface.

It has the following syntax:

Syntax: http://[user:password@]IP_Address[:Port_Number]/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v
- User:password are user & password to connect to the Robot

- IP_Address is the TCP/IP address of the Robot, Port is the port used to access the R2D2 API

- R2D2Commmand is the R2D2 API command to be executed

- arg1 to argn are depend on the R2D2 API command used.

Argument between brackets are optionnals.

Examples: If Robot's credentials are user=root and password=admin, at IP Address 192.168.1.1 with port 8000:
  • http://root:admin@192.168.1.1:8000/cgi-bin?command=StartGsmPort=&arg1=0
  • http://root:admin@192.168.2.1:8000/cgi-bin?command=SendAtCommand=&arg1=ATI4

http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v