Uduino | Unity Script Reference

Docs

Initialization and setup

void pinMode(int pin, PinMode mode)

Description

Create a new digital Pin and setup the mode if the pin is not registered. If the pin exsists, change only the mode

Parameters

Name	Description
`pin`	`int`to initialize
`mode`	`PinMode`PinMode to init pin

Example

void Setup() {
UduinoManager.Instance.pinMode(9, PinMode.Output);
}

void pinMode(AnalogPin pin, PinMode mode)

Description

Create a new analog Pin and setup the mode if the pin is not registered. If the pin exsists, change only the mode

Parameters

Name	Description
`pin`	`AnalogPin`Analog pin to initialize
`mode`	`PinMode`PinMode to init pin

Example

void Setup() {
UduinoManager.Instance.pinMode(AnalogPin.A0, PinMode.Input);
}

void pinMode(UduinoDevice target, AnalogPin pin, PinMode mode)

Description

Change the pinMode of an analog pin on a specific board, when multiple boards are connected.

Parameters

Name	Description
`target`	`UduinoDevice`Target object
`pin`	`AnalogPin`to init
`mode`	`PinMode`PinMode to init pin

Example

void Setup() {
UduinoManager.Instance.OnBoardConnected += OnBoardConnected;
}
void OnBoardConnected(UduinoDevice connectedDevice)
{
if (connectedDevice.name == "uduinoBoard") {
UduinoManager.Instance.pinMode(connectedDevice, 9, PinMode.Servo);
}
else if (connectedDevice.name == "otherBoard") {
UduinoManager.Instance.pinMode(connectedDevice, AnalogPin.10, PinMode.Input);
}
}

void pinMode(UduinoDevice target, int pin, PinMode mode)

Description

Change the pinMode of a digital pin on a specific board, when multiple boards are connected.

Parameters

Name	Description
`target`	`UduinoDevice`Target object
`pin`	`int`to init
`mode`	`PinMode`PinMode to init pin

Example

void Setup() {
UduinoManager.Instance.OnBoardConnected += OnBoardConnected;
}
void OnBoardConnected(UduinoDevice connectedDevice)
{
if (connectedDevice.name == "uduinoBoard") {
UduinoManager.Instance.pinMode(connectedDevice, 9, PinMode.Servo);
}
else if (connectedDevice.name == "otherBoard") {
UduinoManager.Instance.pinMode(connectedDevice, AnalogPin.10, PinMode.Input);
}
}

Send a command

void sendCommand(string command, params object[] value)

Description

Send a custom command to the Arduino

Parameters

Name	Description
`command`	`string`Command Name
`value`	`object[]`List of any parameters. This object is later cast as string

Example

void Update() {
UduinoManager.Instance.sendCommand("turnLED", "on"); //or "off"
UduinoManager.Instance.sendCommand("setBrightness", 20, 150, 255);
}

void sendCommand(UduinoDevice target, string command, params object[] value)

Description

Send a custom command to a specific Arduino, when multiple boards are connected

Parameters

Name	Description
`command`	`string`Command Name
`target`	`string`Command Name
`value`	`object[]`List of any parameters. This object is later cast as string

Example

void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoardName");
UduinoManager.Instance.sendCommand(board, "turnLED", "on"); //or "off"
UduinoManager.Instance.sendCommand(board, "setBrightness", 20, 150, 255);
}

void sendCommand(UduinoDevice target, string message=null, string bundle = null)

Description

Send a custom command to Arduino, with the message as an unique string

Parameters

Name	Description
`target`	`UduinoDevice`Target device
`message`	`string`Message to write, including command and parameters
`bundle`	`string`Optional bundle name

Example

void Update() {
string message = UduinoManager.BuildMessageParameters(10, "on", 255, "off");
UduinoManager.Instance.sendCommand("setBrightness", message);
}

Digital Read/Write

void digitalWrite(int pin, int value, string bundle=null)

Description

Write a digital value to a pin

Parameters

Name	Description
`pin`	`int`Target Pin
`value`	`int`Value to send
`bundle`	`string`Optional Bundle name

Example

void Start() {
UduinoManager.Instance.pinMode(9, PinMode.Output);
}

void Update() {
UduinoManager.Instance.digitalWrite(9, 150);
}

void digitalWrite(int pin, State state=State.LOW, string bundle=null)

Description

Write a digital value to a pin

Parameters

or LOW(0))

Name	Description
`pin`	`int`Target Pin
`state`	`State`Value to send, HIGH(255
`bundle`	`string`Optional Bundle

Example

void Start() {
UduinoManager.Instance.pinMode(13, PinMode.Output);
}

void Update() {
UduinoManager.Instance.digitalWrite(13, PinMode.HIGH);
}

void digitalWrite(UduinoDevice target, int pin, int value, string bundle=null)

Description

Write a digital value to a pin

Parameters

Name	Description
`target`	`UduinoDevice`Target board
`pin`	`int`Target Pin
`value`	`int`Value to send, either 0 or 255 [high or low]
`bundle`	`string`Optional Bundle

Example

void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoard");
UduinoManager.Instance.digitalWrite(board, 9, 255);
}

void digitalWrite(UduinoDevice target, int pin, State state=State.LOW, string bundle=null)

Description

Write a digital value to a pin

Parameters

or LOW(0))

Name	Description
`target`	`UduinoDevice`Target board
`pin`	`int`Target Pin
`state`	`State`Value to send, HIGH(255
`bundle`	`string`Optional Bundle

Example

void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoard");
UduinoManager.Instance.digitalWrite(board, 13, PinMode.LOW);
}

void digitalRead(int pin, string bundle=null)

Description

Reading a digital value (eg. button)

Parameters

Name	Description
`pin`	`int`Target Pin
`bundle`	`string`Optional Bundle

Returns

Digital value as int

Name	Description

Example

void Start() {
UduinoManager.Instance.pinMode(13, PinMode.Input_Pullup);
}

void Update() {
int buttonValue = UduinoManager.Instance.digitalRead(13);
Debug.Log(buttonValue);
}

void digitalRead(UduinoDevice target, int pin, string bundle=null)

Description

Read a digital value (ex button)

Parameters

Name	Description
`target`	`UduinoDevice`Target board
`pin`	`int`Target Pin
`bundle`	`string`Optional Bundle

Returns

Digital Value as int

Name	Description

Example

void Start() {
UduinoManager.Instance.pinMode(4, PinMode.Input_Pullup);
}

void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoard");
int buttonValue = UduinoManager.Instance.digitalRead(board, 4);
Debug.Log(buttonValue);
}

Analog Read/Write

void analogWrite(int pin, string bundle=null)

Description

Write an analog value to Arduino

Parameters

Name	Description
`pin`	`int`Pin to write
`value`	`int`Value from 0 to 255
`bundle`	`string`Optional Bundle

Example

void Start() {
UduinoManager.Instance.pinMode(6, PinMode.Output);
}

void Update() {
UduinoManager.Instance.analogWrite(6, 145);
}

void analogWrite(int pin, int value, string bundle=null)

Description

Write an analog value to Arduino

Parameters

Name	Description
`target`	`UduinoDevice`Target board
`pin`	`int`Pin to write
`value`	`int`Value from 0 to 255
`bundle`	`string`Optional Bundle

Example

void Start() {
UduinoManager.Instance.pinMode(6, PinMode.Output);
}

void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoard");
UduinoManager.Instance.analogWrite(board, 6, 79);
}

void analogRead(AnalogPin pin, string bundle=null)

Description

Read an analog pin

Parameters

Name	Description
`pin`	`AnalogPin`Analog pin to read
`bundle`	`string`Optional Bundle

Returns

Analog value as int, range 0-1024

Name	Description

Example

void Start() {
UduinoManager.Instance.pinMode(AnalogPin.A0, PinMode.Input);
}
void Update() {
int value = UduinoManager.Instance.analogRead(AnalogPin.A0);
Debug.Log(value);
}

void analogRead(int pin, string bundle=null)

Description

Read an analog pin

Parameters

Name	Description
`pin`	`int`Pin to read, as int. See the pinout of your board.
`bundle`	`string`Optional Bundle

Returns

Analog value as int, range 0-1024

Name	Description

Example

void Start() {
UduinoManager.Instance.pinMode(18, PinMode.Input); // In arduino uno, pin 18 is the pin A4
}
void Update() {
int value = UduinoManager.Instance.analogRead(18);
Debug.Log(value);
}

void analogRead(UduinoDevice target, AnalogPin pin, string bundle=null)

Description

Read an analog pin

Parameters

Name	Description
`target`	`UduinoDevice`Target board
`pin`	`AnalogPin`Pin to read
`bundle`	`string`Optional Bundle

Returns

Analog value as int, range 0-1024

Name	Description

Example


void Start() {
UduinoManager.Instance.pinMode(AnalogPin.A0, PinMode.Input); // In arduino uno, pin 18 is the pin A4
}
void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoardName");
int value = UduinoManager.Instance.analogRead(board, AnalogPin.A0);
Debug.Log(value);
}

void analogRead(UduinoDevice target, int pin, string bundle=null)

Description

Read an analog pin

Parameters

Name	Description
`target`	`UduinoDevice`Target board
`pin`	`int`Pin to read
`bundle`	`string`Optional Bundle

Returns

Analog value as int, range 0-1024

Name	Description

Example


void Start() {
UduinoManager.Instance.pinMode(18, PinMode.Input); // In arduino uno, pin 18 is the pin A4
}
void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoardName");
int value = UduinoManager.Instance.analogRead(board, 18);
Debug.Log(value);
}

Message Bundle

void SendBundle(UduinoDevice target, string bundleName)

Description

Send an existing message bundle to Arduino

Parameters

Name	Description
`target`	`UduinoDevice`Uduino Device
`bundleName`	`string`Bundle name

Example

void Update() {
UduinoDevice board = UduinoManager.Instance.GetBaord("uduinoBoardName");
UduinoManager.Instance.SendBundle(board, "bundleName");
}

static string BuildMessageParameters(params object[] parameters)

Description

Build a Uduino message from a list of elements

Parameters

Name	Description
`parameters`	`object[]`List of a variable number of parameters

Returns

string: Return a string composed of the array elements, separated by the parameter delimiter

Name	Description

Example

void Update() {
string message = UduinoManager.BuildMessageParameters(10, "on", 255, "off");
UduinoManager.Instance.sendCommand("setBrightness", message);
}

void SendBundle(string bundleName)

Description

Send an existing message bundle to Arduino

Parameters

Name	Description
`bundleName`	`string`Bundle name

Example

void Update() {
UduinoManager.Instance.SendBundle("bundleName");
}

Board and Pin settings

void SetBoardType(string type)

Description

Set the board type, when only one board is connected.

Parameters

Name	Description
`Board Type`	`Type of Board`Arduino Uno, Arduino Duemilanove, Arduino Leonardo, Arduino Pro Mini,Arduino Mega, Arduino Due, Arduino Nano, Arduino Mini

Example

void Setup() {
UduinoManager.Instance.SetBoardType("Arduino Mega");
customPinAnalog = UduinoManager.Instance.GetPinNumberFromBoardType("Arduino Mega", 52);
UduinoManager.Instance.pinMode(customPinAnalog, PinMode.Output);
}

void SetBoardType(UduinoDevice target, string type)

Description

Set the board type of a specific arduino board

Parameters

Name	Description
`target`	`UduinoDevice`Target Arduino Board
`Board Type`	`Type of board`Arduino Uno, Arduino Duemilanove, Arduino Leonardo, Arduino Pro Mini,Arduino Mega, Arduino Due, Arduino Nano, Arduino Mini

Example

void Setup() {
UduinoManager.Instance.OnBoardConnected += OnBoardConnected;
}
void OnBoardConnected(UduinoDevice connectedDevice)
{
if (connectedDevice.name == "uduinoBoard") {
UduinoManager.Instance.SetBoardType(connectedDevice, "Arduino Mega");
} else if (connectedDevice.name == "otherBoard") {
UduinoManager.Instance.SetBoardType(connectedDevice, "Arduino Uno");
}
}

int GetPinNumberFromBoardType(string boardType, string pin)

Description

Get the pin int id from specific board type

Parameters

)

Name	Description
`boardType`	`string`Type of Arduino board
`pin`	`string`Pin to find (Digital or Analog
`Board Type`	`You can get the pin from this board types`Arduino Uno, Arduino Duemilanove, Arduino Leonardo, Arduino Pro Mini,Arduino Mega, Arduino Due, Arduino Nano, Arduino Mini

Returns

Name	Description
`Arduino pin`	`int`The id of the arduino pin of this board

Example

void Setup() {
UduinoManager.Instance.SetBoardType("Arduino Mega");
customPinAnalog = UduinoManager.Instance.GetPinNumberFromBoardType("Arduino Mega", "A14");
UduinoManager.Instance.pinMode(customPinAnalog, PinMode.Input);
}

int GetPinNumberFromBoardType(string boardType, int pin)

Description

Get the pin from specific board type

Parameters

)

Name	Description
`boardType`	`string`Type of Arduino board
`pin`	`int`Pin to find (Digital
`Board Type`	`You can get the pin from this board types`Arduino Uno, Arduino Duemilanove, Arduino Leonardo, Arduino Pro Mini,Arduino Mega, Arduino Due, Arduino Nano, Arduino Mini

Returns

Name	Description
`Arduino pin`	`int`The id of the arduino pin of this board

Example

void Setup() {
UduinoManager.Instance.SetBoardType("Arduino Mega");
customPinAnalog = UduinoManager.Instance.GetPinNumberFromBoardType("Arduino Mega", 52);
UduinoManager.Instance.pinMode(customPinAnalog, PinMode.Output);
}

void SetReadCallback(Action callback)

Description

Set read callback for all connected boards

Parameters

Name	Description
`callback`	`Action`Callback function

Returns

Name	Description
`callback`	`Action`Callback function

Example

void Start() {
UduinoManager.Instance.SetReadCallback(ValueReceived);
}

void ValueReceived(string value) {
Debug.Log(value);
}

void SetReadCallback(UduinoDevice target, Action callback)

Description

Set read callback of a specific board

Parameters

Name	Description
`target`	`UduinoDevice`Target device
`callback`	`Action`Callback function

Example

void Setup() {
UduinoManager.Instance.OnBoardConnected += OnBoardConnected;
}

void OnBoardConnected(UduinoDevice connectedDevice)
{
if (connectedDevice.name == "uduinoBoard") {
UduinoManager.Instance.SetReadCallback(connectedDevice, ValueReceivedBoardOne);
}
else if (connectedDevice.name == "otherBoard") {
UduinoManager.Instance.pinMode(connectedDevice, ValueReceivedBoardTwo);
}
}

void ValueReceivedBoardOne(string value) {
Debug.Log(value);
}

void ValueReceivedBoardTwo(string value) {
Debug.Log(value);
}

Other methods

void DiscoverPorts()

Description

Find and register all boards connected

void GetPortState()

Description

Display in console the current state of all boards

void CloseAllDevices()

Description

Close all opened serial ports

Deprecated

These functions were present in Uduino 1.4.3
but have been deprecated in Uduino 2.0.0+

void InitPin(int pin, PinMode mode)

Description

Initialize an arduino pin

Parameters

Name	Description
`pin`	`int`to initialize
`mode`	`PinMode`PinMode to init pin

void InitPin(AnalogPin pin, PinMode mode)

Description

Init a pin

Parameters

Name	Description
`pin`	`AnalogPin`Analog pin to initialize
`mode`	`PinMode`PinMode to init pin

void InitPin(string target, AnalogPin pin, PinMode mode)

Description

Init a pin

Parameters

Name	Description
`target`	`string`Target Name
`pin`	`AnalogPin`to init
`mode`	`PinMode`PinMode to init pin

void InitPin(string target, int pin, PinMode mode)

Description

Create a new Pin and setup the mode if the pin is not registered. If the pin exsists, change only the mode

Parameters

Name	Description
`target`	`string`Target Name
`pin`	`int`to init
`mode`	`PinMode`PinMode to init pin

void Write(string target=null, string message=null, string bundle=null, Action>string> description)

Description

Send a read command to a specific arduino. A read command will be returned in the OnValueReceived() delegate function

Parameters

Name	Description
`target`	`string`Target device name. Not defined means read everything
`message`	`string`Variable watched, if defined
`timeout`	`int`Read Timeout, if defined
`action`	`Action< string >`Action callback

void Write(string target=null, string message=null, string bundle=null)

Description

Write a command on an Arduino

Parameters

Name	Description
`target`	`string`Target device
`message`	`string`Message to write in the serial

void Write(string target, string message, int value)

Description

Write a command on an Arduino with a specific value

Parameters

Name	Description
`target`	`string`Target device
`message`	`string`Message to write in the serial
`value`	`int`Optional value

void CloseAllPorts()

Description

Replaced with CloseAllDevices()

Parameters

Name	Description
`name`	`int`desc