Arduino Internet / Web Control with Teleduino

API (328 full)

The sample URLs in this documentation can optionally be set to your key, which makes them relevant and functional for your device.

If you wish to set your key, enter it in the following form and click 'Set Key'.

Introduction

Sending instructions and retrieving values from your online Teleduino device is acheived by interacting with the Teleduino API.

Requests can be submitted to the API using either GET or POST, and the returned result can be in either JSON (default), JSONP or serialised PHP.

For the examples provided in this document, the GET method will be used.

Request URL

The request URL will depend on which proxy server your device is connected to.

For the examples provided in this document, the request URL will be https://us01.proxy.teleduino.org/api/1.0/328.php.

Returned Data Packet

All returned data packets consist of three parameters at the top level. They are:

Parameter	Datatype	Description
status	Integer	The status code of the API response. These are matched as close as possible to HTTP status codes.
message	Text	A simple message explaining the status code.
response	Array	The resulting data packet response from the Teleduino.

When a response is received back from the device (status = 200), the response array will consist of three parameters. They are:

Parameter	Datatype	Description
result	Integer	Whether or not the request was successful. Possible values are 1 or 0.
time	Float	The time (in seconds) that the request took to complete.
values	Array	The returned value(s). Will remain as an empty array if no values are returned.

Analog Pin Addressing

The analog pins on the Arduino can also be used as digital pins. To keep things simple when using the Teleduino, the analog pin numbering is different to the native Arduino.

The following table shows the pin value to be used for addressing the analog pins:

Arduino Pin	Teleduino Pin
A0	14
A1	15
A2	16
A3	17
A4	18
A5	19
A6*	20
A7*	21

* Some alternate brand Arduino boards support two extra analog pins. These additional pins can not be used for digital output.

Common Parameter Values

There are some parameter values that are used regardless of which method is being called.

These common parameter values are represented by a single character and are explained in the following table:

Parameter	Datatype	Required?	Default	Description
k	String	Yes		The unique API key for the device.
r	String	Yes		The method being requested.
o	String	No	json	The output format. Possible values are json, jsonp or php.
p	String	No	TeleduinoReturn	When the selected output format is jsonp, this sets the callback function name.
s	Integer	No	1	Whether or not to set the HTTP status header. Possible values are 1 or 0.

Methods

The following definitions expain in detail the methods available via the API.

Select from the list to view to a specific definition:

reset

Resets the device.

Example Request:

https://us01.proxy.teleduino.org/api/1.0/328.php?k={KEY}&r=reset

Example Response:

{
	"status":200,
	"message":"OK",
	"response":{
		"result":1,
		"time":0.19380688667297,
		"values":[]
	}
}

Parameter	Datatype	Description
pin	Integer	Digital pin. Possible values are 0 - 19.
mode	Integer	Mode. Possible values are 0 (input) or 1 (output).

Parameter	Datatype	Description
pin	Integer	Digital pin. Possible values are 0 - 19.
output	Integer	Output. Possible values are 0 (low), 1 (high) or 2 (toggle).
expire_time	Integer	Optional expire time (in milliseconds) for output. 0 means no expiry. Possible values are 0 - 16777215.
save	Integer	Optionally save the output as a preset (328-0.6.9 and above). Can only be set if expire_time is 0. Possible values are 0 (don't save) or 1 (save).

Parameter	Datatype	Description
pin	Integer	PWM pin. Possible values are 3, 5 - 7, 9 - 11.
output	Integer	Output. Possible values are 0 (low) - 255 (high).

Parameter	Datatype	Description
outputs	Integer	An array of outputs. Possible values are 0 (low), 1 (high) or 2 (toggle).
expire_times	Integer	Optional array of expire times (in milliseconds) for output. 0 means no expiry. Possible values are 0 - 16777215.
offset	Integer	Optional array offset. Defaults to 0. When 0: output[0] = pin 0, output[1] = pin 1 When 5: output[0] = pin 5, output[1] = pin 6 etc

Parameter	Datatype	Description
shift_register	Integer	The shift register cascade we are defining. Possible values are 0 or 1.
clock_pin	Integer	The digital pin which is connected to the shift register clock pin. Possible values are 0 - 21.
data_pin	Integer	The digital pin which is connected to the shift register data pin. Possible values are 0 - 21.
latch_pin	Integer	The digital pin which is connected to the shift register latch pin. Possible values are 0 - 21.
enable_pin	Integer	Optional. The digital pin which is used to enable the shift register. Possible values are 0 - 21.

Parameter	Datatype	Description
shift_register	Integer	The shift register cascade we are setting. Possible values are 0 or 1.
outputs	Integer	An array of integers. Each element of the array represents a shift register (up to 32). Possible values per element are 0 - 255.

Parameter	Datatype	Description
port	Integer	The port we are defining. The only possible value is 0.
baud	Integer	The baud rate of the port. Possible values are per element are 300, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600 or 115200.

Parameter	Datatype	Description
port	Integer	The port we are writing to. The only possible value is 0.
bytes	Text	Text to send to the serial port. Maximum length is 254 bytes.

Parameter	Datatype	Description
port	Integer	The port we are reading from. The only possible value is 0.
byte_count	Integer	Maximum number of bytes to read from the serial port. Possible values are 0 - 255.

Parameter	Datatype	Description
servo	Integer	Servo instance. Possible values are 0 - 5.
pin	Integer	Digital pin. Possible values are 0 - 21.

Parameter	Datatype	Description
offset	Integer	Starting position of the EEPROM to write to.
bytes	Text	Text to write to the EEPROM. Maximum length is 253 bytes.

Parameter	Datatype	Description
offset	Integer	Starting position of the EEPROM to read from.
byte_count	Integer	Number of bytes to read from the EEPROM. Possible values are 0 - 255.

Parameter	Datatype	Description
address	Integer	The 7 bit address of the device to write to. Possible values are 1 - 127.
bytes	Text	Text to write to the Wire (TWI/I2C) bus. Maximum length is 32 bytes.

Teleduino

Arduino Internet / Web Control

API (328 full)

Introduction

Request URL

Returned Data Packet

Analog Pin Addressing

Common Parameter Values

Methods

System

I/O

Shift Registers

Serial

Servo

EEPROM

Wire (TWI/I2C)

reset

Example Request:

Example Response:

getVersion

Example Request:

Response Value Parameters:

Example Response:

setStatusLedPin

Request Parameters:

Example Request:

Example Response:

setStatusLed

Request Parameters:

Example Request:

Example Response:

getFreeMemory

Example Request:

Response Value Parameters:

Example Response:

ping

Example Request:

Example Response:

getUptime

Example Request:

Response Value Parameters:

Example Response:

loadPresets

Example Request:

Example Response:

definePinMode

Request Parameters:

Example Request:

Example Response:

setDigitalOutput

Request Parameters:

Example Request:

Example Response:

setPwmOutput

Request Parameters:

Example Request:

Example Response:

getDigitalInput

Request Parameters:

Example Request:

Response Value Parameters:

Example Response:

getAnalogInput

Request Parameters:

Example Request:

Response Value Parameters:

Example Response:

getAllInputs

Example Request:

Response Value Parameters:

Example Response:

setDigitalOutputs

Request Parameters:

Example Request:

Example Response:

defineShiftRegister

Request Parameters:

Example Request:

Example Response:

setShiftRegister