R2D2 HTTP API - Revision history

Administrator at 07:51, 4 June 2024

2024-06-04T07:51:47Z

← Older revision		Revision as of 07:51, 4 June 2024
Line 4:		Line 4:
	{\| class="wikitable"		{\| class="wikitable"
	\|'''Syntax''':		\|'''Syntax''':
	\|http://['''user:password'''@]'''IP_Address'''[:'''Port_Number]'''/cgi-bin?command='''R2D2Command'''&'''arg1'''=val1&'''arg2'''=val2...&'''~~argn~~'''=v		\|http://['''user:password'''@]'''IP_Address'''[:'''Port_Number]'''/cgi-bin?command='''R2D2Command'''&'''arg1'''=val1&'''arg2'''=val2...&'''argN'''=v
	\|-		\|-
	\|		\|
Line 13:		Line 13:
	- '''R2D2Commmand''' is the R2D2 API command to be executed		- '''R2D2Commmand''' is the R2D2 API command to be executed

	- '''arg1''' to '''~~argn~~''' depend on the arguments of the R2D2 API command ~~used~~.		- '''arg1''' to '''argN''' depend on the arguments needed for the R2D2 API command entered.

	Argument between brackets are ~~optionnals~~.		Argument between brackets are optionals.
	\|-		\|-
	\|'''Examples:'''		\|'''Examples:'''

2024-06-04T07:50:37Z

← Older revision		Revision as of 07:50, 4 June 2024
Line 52:		Line 52:
	<code>reg query services/gsmrobotd/parameters /v HTTPSListeningPort</code>		<code>reg query services/gsmrobotd/parameters /v HTTPSListeningPort</code>

	It will return ~~either~~ the HTTP or the HTTPS Listening port depending on the command entered.		It will either return the HTTP or the HTTPS Listening port depending on the command above entered.

2024-06-03T22:15:42Z

@@ Line 2: / Line 2: @@
 It has the following syntax:
-{|
+{| class="wikitable"
 |'''Syntax''':
 |http://['''user:password'''@]'''IP_Address'''[:'''Port_Number]'''/cgi-bin?command='''R2D2Command'''&'''arg1'''=val1&'''arg2'''=val2...&'''argn'''=v
@@ Line 13: / Line 13: @@
 - '''R2D2Commmand''' is the R2D2 API command to be executed
-- '''arg1''' to '''argn''' are depend on the R2D2 API command used.
+- '''arg1''' to '''argn''' depend on the arguments of the R2D2 API command used.
 Argument between brackets are optionnals.
@@ Line 24: / Line 24: @@
 * <nowiki>http://root:admin@192.168.2.1:8000/cgi-bin?command=SendAtCommand=&arg1=ATI4</nowiki>
 |}
-<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v</nowiki>
+In order to allow the HTTP interface to work, it has to be enabled by the following command (through SSH):

2024-06-03T21:44:54Z

← Older revision		Revision as of 21:44, 3 June 2024
Line 4:		Line 4:
	{\|		{\|
	\|'''Syntax''':		\|'''Syntax''':
	\|~~<nowiki>~~http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v~~</nowiki>~~		\|http://['''user:password'''@]'''IP_Address'''[:'''Port_Number]'''/cgi-bin?command='''R2D2Command'''&'''arg1'''=val1&'''arg2'''=val2...&'''argn'''=v
	\|-		\|-
	\|		\|
	\|~~<nowiki>~~- User:password are user & password to connect to the Robot~~</nowiki>~~		\| - '''User:password''' are user & password to connect to the Robot

	- IP_Address is the TCP/IP address of 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:

			* <nowiki>http://root:admin@192.168.1.1:8000/cgi-bin?command=StartGsmPort=&arg1=0</nowiki>

			* <nowiki>http://root:admin@192.168.2.1:8000/cgi-bin?command=SendAtCommand=&arg1=ATI4</nowiki>
	\|}		\|}
	<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v</nowiki>		<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v</nowiki>

2024-06-03T21:23:30Z

← Older revision		Revision as of 21:23, 3 June 2024
Line 2:		Line 2:

	It has the following syntax:		It has the following syntax:
	{\| ~~class="wikitable"~~		{\|
	!Syntax:		\|'''Syntax''':
	!<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=~~valn~~</nowiki>		\|<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v</nowiki>
			\|-
			\|
			\|<nowiki>- User:password are user & password to connect to the Robot</nowiki>

			- IP_Address is the TCP/IP address of the Robot
	\|}		\|}
	<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=~~valn~~</nowiki>		<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=v</nowiki>

2024-06-03T21:17:14Z

← Older revision		Revision as of 21:17, 3 June 2024
Line 4:		Line 4:
	{\| class="wikitable"		{\| class="wikitable"
	!Syntax:		!Syntax:
	~~!'''<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=valn</nowiki>'''~~
	\|-
	!
	!<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=valn</nowiki>		!<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=valn</nowiki>
	\|}		\|}
			<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=valn</nowiki>

2024-06-03T21:15:10Z

← Older revision		Revision as of 21:15, 3 June 2024
Line 1:		Line 1:
	~~The~~ R2D2 API can be accessed through a HTTP Interface. F		Any command from the R2D2 API can be accessed through a HTTP Interface.

			It has the following syntax:
			{\| class="wikitable"
			!Syntax:
			!'''<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=valn</nowiki>'''
			\|-
			!
			!<nowiki>http://user:password@IP_Address:Port_Number/cgi-bin?command=R2D2Command&arg1=val1&arg2=val2...&argn=valn</nowiki>
			\|}

2024-06-03T18:24:25Z

Created page with "The R2D2 API can be accessed through a HTTP Interface. F"

New page

The R2D2 API can be accessed through a HTTP Interface. F