Standard Library

---

These standard library functions are built in natively into the firmware and are available on all systems. You will likely not use these directly, but use the simpler wrapper methods provided by the individual modules.

tip

These are particularly useful for using DUELink Microcomputers or for making custom modules.

---

caution

Unless otherwise is stated, all Standard Libraries that calls for array require a byte array and not a float array. Use b1 for example instead of a1.

Special Pins

Some functions only work on pins with specific features.

• Analog capable pins: P1, P2, P3, P4, P5, P6, P7, P8, P9, P17
• Interrupt capable pins: P1, P2, P3, P4, P5, P6, P7, P12
• PWM capable pins: P1, P2, P3, P4, P5, P6, P7, P8, P11

tip

PWM pins share timers. Changing the frequency on one will effect the other. Changing duty-cycle is okay however!

• P1, P2
• P3
• P4, P11
• P5, P6, P7, P8

---

Print

Print to output.

Function	Description
Print("text" or variable)	Print the value of its argument.
PrintLn("text" or variable)	Print the value of its argument with line breaks.

Print() accepts multiple argument, separated by commas, Print("Value is: ", _v)

tip

Print is invoked automatically when a function returns a value that is not consumed. Running DRead(1, 1) in immediate mode will show 0 or 1.

Samples

Script

Print("DUELink")
PrintLn(" is awesome!")
_x=100
PrintLn(_X)
Print("_X = ", _X)

Python

Not needed. Use Python's native print() method.

MicroPython

Not needed. Use JavaScript native facilities.

JavaScript

Not needed. Use Arduino native facilities.

.NET

Not needed. Use MicroPython native facilities.

Arduino

Not needed. Use .NET native facilities.

---

Timing

Function	Description
Wait(duration)	Wait for duration milliseconds.
TickMs()	Read system ticks in milliseconds.
TickUs()	Read system ticks in microseconds.

Samples

Script

 _T = TickMs()
PrintLn("Current tick = ",_T)
Wait(5000)
_N = TickMs()
PrintLn("New tick = ",_N)
PrintLn("Delta = ",_N - _T)

Python

# Wait is not provided, use native facilities
ms = duelink.System.GetTickMilliseconds()
us = duelink.System.GetTickMicroseconds()

MicroPython

// Wait is not provided, use native facilities
ms = await duelink.System.GetTickMilliseconds();
us = await duelink.System.GetTickMicroseconds();

JavaScript

// Wait is not provided, use native facilities
ms = duelink.System.GetTickMilliseconds();
us = duelink.System.GetTickMicroseconds();

.NET

# Wait is not provided, use native facilities
ms = duelink.System.GetTickMilliseconds()
us = duelink.System.GetTickMicroseconds()

Arduino

// Wait is not provided, use native facilities
ms = duelink.System.GetTickMilliseconds();
us = duelink.System.GetTickMicroseconds();

---

Pin Control

Status LED

Control the on-board STAT LED, found on every single DUELink module.

Function	Description
StatLed(high, low, count)	Blink the status (STAT) LED with high duration on in milliseconds and low duration in milliseconds. Repeat count, use 0 to repeat forever.

The status LED is automatically controlled by the engine by default, as explained on the Specs page. Calling StatLed() will take control over the LED. It is possible to release LED back to the engine by calling StatLed(0,0,0).

Samples

Script

# Blink the STAT LED on for 1000 milliseconds, off for 1000 milliseconds, 10 times. 
StatLed(1000, 1000, 10)
# Wait for 5 seconds
Wait(5000)
# Release the Status LED back to the system
StatLed(0, 0, 0)

Python

#Blink the STAT LED on for 1000 milliseconds, off for 1000 milliseconds, 10 times. 
duelink.System.StatLed(1000, 1000, 10)
# Wait for 5 seconds
time.sleep(5)
# Release the Status LED back to the system
duelink.System.StatLed(0, 0, 0)

MicroPython

//Blink the STAT LED on for 1000 milliseconds, off for 1000 milliseconds, 10 times. 
await duelink.System.StatLed(1000, 1000, 10);
// Wait 5 seconds
await Util.sleep(5000);
// Release the Status LED back to the system
await duelink.System.StatLed(0, 0, 0);

JavaScript

// Blink the STAT LED on for 1000 milliseconds, off for 1000 milliseconds, 10 times. 
duelink.System.StatLed(1000, 1000, 10);
// Wait for 5 seconds
delay(5000);
// Release the Status LED back to the system
duelink.System.StatLed(0, 0, 0);

.NET

#Blink the STAT LED on for 1000 milliseconds, off for 1000 milliseconds, 10 times. 
duelink.System.StatLed(1000, 1000, 10)
# Wait for 5 seconds
time.sleep(5)
# Release the Status LED back to the system
duelink.System.StatLed(0, 0, 0)

Arduino

// Blink the STAT LED on for 1000 milliseconds, off for 1000 milliseconds, 10 times. 
duelink.System.StatLed(1000, 1000, 10);
// Wait for 5 seconds
Thread.Sleep(5000);
// Release the Status LED back to the system
duelink.System.StatLed(0, 0, 0);

---

Digital

Access digital pins.

Function	Description
DRead(pin, pull)	Returns the digital state of pin. Enable pull (0 none, 1 up, 2 down).
DWrite(pin, state)	Sets pin to state: 1 = high or 0 = low.

Samples

Script

# Read the current level of pin 1, with pull-down resistor enabled
_P = DRead(1,2)
# Set pin 2 to high (active) state
DWrite(2,1)

Python

# Read the current level of pin 1, with pull-down resistor enabled
pinState = duelink.Digital.Read(1,2)
# Set pin 2 to high (active) state
duelink.Digital.Write(2,1)

MicroPython

// Read the current level of pin 1, with pull-down resistor enabled
await pinState = duelink.Digital.Read(1,2);
// Set pin 2 to high (active) state
await duelink.Digital.Write(2,1);

JavaScript

// Read the current level of pin 1, with pull-down resistor enabled
pinState = duelink.Digital.Read(1,2);
// Set pin 2 to high (active) state
duelink.Digital.Write(2,1);

.NET

# Read the current level of pin 1, with pull-down resistor enabled
pinState = duelink.Digital.Read(1,2)
# Set pin 2 to high (active) state
duelink.Digital.Write(2,1)

Arduino

// Read the current level of pin 1, with pull-down resistor enabled
pinState = duelink.Digital.Read(1,2);
// Set pin 2 to high (active) state
duelink.Digital.Write(2,1);

---

Analog

Access pins in an analog format.

Function	Description
ARead(pin)	Read the analog level on pin (0 to 4095).
VRead(pin)	Read calibrated voltage level on pin.
AWrite(pin, power)	Sets the power level on pin using PWM. Power level is 0 to 1, 0.33 is 33% for example.

VRead() and ARead() only works with analog capable pins, see Special Pins.

AWrite() only works on PWM pins, see Special Pins.

tip

AWrite() changes the internal timer frequency to 1Khz, see Special Pins.

Samples

Script

# Read the voltage level at pin 3
_V = VRead(3)
# Read the analog input on pin 2
_A = Aread(2)
# Set power level (duty-cycle) of pin 4 to 33%
AWrite(4, 0.33)

Python

# Read the voltage level at pin 3
voltage = duelink.Analog.VoltRead(3)
# Read the analog input on pin 2
analog = duelink.Analog.Read(2)
# Set power level (duty-cycle) of pin 4 to 33%
duelink.Analog.Write(4, 0.33)

MicroPython

// Read the voltage level at pin 3
await duelink.Analog.VoltRead(3)
// Read the analog input on pin 2
analog = duelink.Analog.Read(2)
// Set power level (duty-cycle) of pin 4 to 33%
await duelink.Analog.Write(4, 0.33)

JavaScript

// Read the voltage level at pin 3
voltage = duelink.Analog.VoltRead(3);
// Read the analog input on pin 2
analog = duelink.Analog.Read(2);
// Set power level (duty-cycle) of pin 4 to 33%
duelink.Analog.Write(4, 0.33);

.NET

# Read the voltage level at pin 3
voltage = duelink.Analog.VoltRead(3)
# Read the analog input on pin 2
analog = duelink.Analog.Read(2)
# Set power level (duty-cycle) of pin 4 to 33%
duelink.Analog.Write(4, 0.33)

Arduino

// Read the voltage level at pin 3
voltage = duelink.Analog.VoltRead(3);
// Read the analog input on pin 2
analog = duelink.Analog.Read(2);
// Set power level (duty-cycle) of pin 4 to 33%
duelink.Analog.Write(4, 0.33);

---

Beep

Generate tones. This is a blocking function that works on all pins.

Function	Description
Beep(pin, frequency, duration)	Generate a beep on pin with frequency for duration in milliseconds.

Samples

Script

# Generate a frequency of 1KHz on pin 1 for 200ms
Beep(1, 1000, 200)

Python

# Generate a frequency of 1KHz on pin 1 for 200ms
duelink.Sound.Beep(1, 1000, 200)

MicroPython

// Generate a frequency of 1KHz on pin 1 for 200ms
await duelink.Sound.Beep(1, 1000, 200)

JavaScript

// Generate a frequency of 1KHz on pin 1 for 200ms
duelink.Sound.Beep(1, 1000, 200);

.NET

# Generate a frequency of 1KHz on pin 1 for 200ms
duelink.Sound.Beep(1, 1000, 200)

Arduino

// Generate a frequency of 1KHz on pin 1 for 200ms
duelink.Sound.Beep(1, 1000, 200);

---

Melody

Generate tones. This is a non-blocking function that works on PWM pins.

MelodyP() requires a float array, use a1 for example. Float arrays must be initialized with {} brackets.

Function	Description
MelodyP(pin, {notes})	A non-blocking call to play a melody in the background on pin using the frequencies and delays found in {notes} float array.
MelodyS(pin)	Stop a melody on pin.

Samples

Script

Dim a1[]={500, 50, # 500Hz for 50ms
        1000, 100} # 1000Hz for 100ms
MelodyP(3, a1)
Wait(2000)
MelodyS(3)

Python

duelink.Sound.MelodyPlay(3, [500, 50, 1000, 100])
time.sleep(2)
duelink.Sound.MelodyStop(4)

MicroPython

await duelink.Sound.MelodyPlay(3, [500, 50, 1000, 100])
await time.sleep(2)
await duelink.Sound.MelodyStop(4)

JavaScript

duelink.Sound.MelodyPlay(3, [500, 50, 1000, 100])
delay(2);
duelink.Sound.MelodyStop(4);

.NET

duelink.Sound.MelodyPlay(3, [500, 50, 1000, 100])
time.sleep(2)
duelink.Sound.MelodyStop(4)

Arduino

duelink.Sound.MelodyPlay(3, new byte[500, 50, 1000, 100])
time.sleep(2);
duelink.Sound.MelodyStop(4);

---

Button

Use interrupts to keep track of pins. Only available on interrupt capable pins, see Special Pins above!

Function	Description
BtnEn(p,l)	Enable button scanning feature on p pin with l as pressed state (0 is low when pressed, 1 is high when pressed).
BtnUp(p)	Returns 1 if p pin transitioned to unpressed state.
BtnDown(p)	Returns 1 if p pin transitioned to a pressed state.
BtnRead(p)	Returns 1 if button on p is currently pressed.

Samples

Script

# Enable button on pin 1 with a low for pressed-state.
BtnEn(1, 1)
# Read the current button state, pressed or unpressed.
_B = BtnRead(1)

Python

# Enable button on pin 1 with a low for pressed-state.
duelink.Button.Enable(1, False)
# Read the current button state, pressed or unpressed.
state = duelink.Button.Read(1)

MicroPython

// Enable button on pin 1 with a low for pressed-state.
await duelink.Button.Enable(1, False);
// Read the current button state, pressed or unpressed.
await state = duelink.Button.Read(1);

JavaScript

// Enable button on pin 1 with a low for pressed-state.
duelink.Button.Enable(1, False);
// Read the current button state, pressed or unpressed.
state = duelink.Button.Read(1);

.NET

# Enable button on pin 1 with a low for pressed-state.
duelink.Button.Enable(1, False)
# Read the current button state, pressed or unpressed.
state = duelink.Button.Read(1)

Arduino

// Enable button on pin 1 with a low for pressed-state.
duelink.Button.Enable(1, False);
// Read the current button state, pressed or unpressed.
state = duelink.Button.Read(1);

---

Frequency

Sets a frequency (PWM) parameters to a pin. Only works on pins that support PWM.

tip

This changes the timer frequency, see Special Pins.

Function	Description
Freq(pin, frequency, duration, dutycycle)	Sets PWM pin to frequency for duration in milliseconds at dutycycle where 1 is 100%, 0.2 is 20%...etc.

Samples

Script

# Sweep though frequencies on pin 3
for _x in range(800,8000,50)
  Freq(3, _x, 100, 0.5)
  Wait(100)
next

Python

for x in range(800,8000,50)
  duelink.Frequency.Write(3, _x, 100, 0.5)
  time.sleep(0.1)
next

MicroPython

for (let x = 800; x <= 8000; x += 50) {
  await duelink.Frequency.Write(3, x, 100, 0.5);
  await Util.sleep(100);
}

JavaScript

for (x=800; x<8000, x=x+50)
{
  duelink.Frequency.Write(3, _x, 100, 0.5);
  time.sleep(0.1);
}

.NET

for x in range(800,8000,50)
  duelink.Frequency.Write(3, _x, 100, 0.5)
  time.sleep(0.1)
next

Arduino

for (x=800; x<8000, x=x+50)
{
  duelink.Frequency.Write(3, _x, 100, 0.5);
  time.sleep(0.1);
}

---

Touch

Read capacitive touch by charging a pin and then reading the discharge time in microseconds.

Function	Description
Touch(pin, charge_t, charge_s, timeout)	Charges pin with charge state charge_s for charge time charge_t in milliseconds then read how long it takes for pin to discharge, returning value in microseconds. timeout is used in case the pin didn't change its state.

Samples

Script

# Read cap-touch on pin 1 with 100ms charing at high state, with 1sec timeout
while 1
    printLn(Touch(1, 100, 1, 1000))
    Wait(1000)
wend

Python

# Read cap-touch on pin 1 with 100ms charing at high state, with 1sec timeout
while True:
    print(duelink.Touch.Read(1, 100, 1, 1000))
    time.sleep(1)

MicroPython

while (true) {
    console.log(await duelink.Touch.Read(1, 100, 1, 1000));
    await Util.sleep(1000);
}

JavaScript

// Read cap-touch on pin 1 with 100ms charing at high state, with 1sec timeout
while(true)
{
    Console.Print(duelink.Touch.Read(1, 100, 1, 1000));
    delay(1000);
}

.NET

# Read cap-touch on pin 1 with 100ms charing at high state, with 1sec timeout
while True:
    print(duelink.Touch.Read(1, 100, 1, 1000))
    time.sleep(1)

Arduino

// Read cap-touch on pin 1 with 100ms charing at high state, with 1sec timeout
while(true)
{
    Console.Print(duelink.Touch.Read(1, 100, 1, 1000));
    Thread.Sleep(1000);
}

---

PulseIn

Reads a pulse on a pin and return time in microseconds.

Function	Description
PulseIn(pin, state, timeout)	Read a pulse width on a pin where the pulse is level selected using state (high or low). If no valid state detected, returns 0. This is a blocking function waiting for the pulse, or returns after timeout milliseconds.

Samples

Script

# Detect low width on pin 3
println(PulseIn(3,0,1000))

Python

print(duelink.Pulse.Read(3,0,1000))

MicroPython

console.log(await duelink.Pulse.Read(3,0,1000))

JavaScript

print(duelink.Pulse.Read(3,0,1000));

.NET

print(duelink.Pulse.Read(3,0,1000))

Arduino

Console.Print(duelink.Pulse.Read(3,0,1000).ToString())

---

Digital Control

Distance

Read distance from ultrasonic distance sensors.

Function	Description
Dist(trig, echo)	Returns distance in centimeters from ultrasonic distance sensor connected to trig and echo pins.

Samples

Script

# Measure ultrasonic distance with trig on pin 2 and echo on pin 1
_D = _Dist(2, 1)

Python

distance = duelink.Distance.Read(2, 1)

MicroPython

await distance = duelink.Distance.Read(2, 1);

JavaScript

distance = duelink.Distance.Read(2, 1);

.NET

distance = duelink.Distance.Read(2, 1)

Arduino

distance = duelink.Distance.Read(2, 1);

---

Servo Motors

Control servo motors.

tip

This changes the timer frequency to 50Hz, see Special Pins.

Function	Description
ServoSt(pin, degree)	Position a servo on pin to degree: 0 to 180

ServoSt() only works with PWM pins, see Special Pins.

Samples

Script

# Servo on pin 1 to 90 degrees
servost(1, 90)

Python

# Servo on pin 1 to 90 degrees
duelink.Servo.Set(1, 90)

MicroPython

// Servo on pin 1 to 90 degrees
await duelink.Servo.Set(1, 90);

JavaScript

// Servo on pin 1 to 90 degrees
duelink.Servo.Set(1, 90);

.NET

# Servo on pin 1 to 90 degrees
duelink.Servo.Set(1, 90)

Arduino

// Servo on pin 1 to 90 degrees
duelink.Servo.Set(1, 90);

---

I2C

Access the I2C bus.

Function	Description
I2cCfg(baudrate)	baudrate: Sets the I2C clock speed in khz, typically 100K or 400K, and 1M in some cases.
I2cWr(address, [arrayWrite], [arrayRead])	address: I2C slave address (7 bits) - arrayWrite: array to send, arrayRead: array to read.

Pins used for I2C are 15-SCL and 16-SDA.

Samples

Script

# Write 2 bytes to 0x3C and do not read anything back
i2ccfg(100) # set clock 100KHz
b1[0] = 1
b1[1] = 2
i2cwr(0x3C,b1,[])

Python

b1 = bytearray([0x01,0x02])
duelink.I2C.Configuration(100)
duelink.I2C.WriteRead(0x3c, b1, 0)

MicroPython

let b1 = new Uint8Array([0x01, 0x02])
await duelink.I2C.Configuration(100)
await duelink.I2C.WriteRead(0x3c, b1, 0)

JavaScript

var b1[] = [0x01,0x02]
duelink.I2C.Configuration(100)
duelink.I2C.WriteRead(0x3c, b1, 0)

.NET

b1 = bytearray([0x01,0x02])
duelink.I2C.Configuration(100)
duelink.I2C.WriteRead(0x3c, b1, 0)

Arduino

var b1 = new byte[]{0x01,0x02}
duelink.I2C.Configuration(100)
duelink.I2C.WriteRead(0x3c, b1, 0)

---

SPI

Access the SPI bus.

Function	Description
SpiCfg(mode, frequency)	Configure SPI with mode: 0 to 3 and frequency in KHz, ranging 200KHz to 20MHz. If LSB is needed, set mode bit 7 to 1 mode=mode|0x80 .
SpiWr(byte)	Write a byte then return the received byte.
SpiWrs([data_w], [data_r])	Write an byte array of data_w , also return an byte array of data_r.

tip

The system defaults to SpiCfg(0,8000), means SPI mode 0, 8MHz, and first bit is MSB.

Pins used for SPI are 12-SCK, 13-MISO, 14-MOSI. Use any GPIO for manual use of CS.

Samples

Script

spicfg(0,8000)
# Write/Read (exchange) a byte
_R = SpiWr(0x55)
# Write B1 array and read back B2
Dim B1[2] = [1,2]
Dim B2[2]
SpiWrs(B1,B2)

Python

duelink.Spi.Configuration(0,8000)

# Write/Read (exchange) a byte
r = duelink.Spi.Write(0x55)

# Write B1 array and read back B2
b1 = bytearray([0x01,0x02])
b2 = bytearray(2)

duelink.Spi.WriteRead(b1,b2)

MicroPython

await duelink.Spi.Configuration(0,8000)

# Write/Read (exchange) a byte
let r = await duelink.Spi.Write(0x55)

# Write B1 array and read back B2
let b1 = new Uint8Array([0x01, 0x02])
let b2 = new Uint8Array()

await duelink.Spi.WriteRead(b1,b2)

JavaScript

duelink.Spi.Configuration(0,8000);

// Write/Read (exchange) a byte
var r = duelink.Spi.Write(0x55);

// Write B1 array and read back B2
var b1 = byte[0x01,0x02];
var b2 = byte[2];

duelink.Spi.WriteRead(b1,b2);

.NET

duelink.Spi.Configuration(0,8000)

# Write/Read (exchange) a byte
r = duelink.Spi.Write(0x55)

# Write B1 array and read back B2
b1 = bytearray([0x01,0x02])
b2 = bytearray(2)

duelink.Spi.WriteRead(b1,b2)

Arduino

duelink.Spi.Configuration(0,8000);

// Write/Read (exchange) a byte
var r = duelink.Spi.Write(0x55);

// Write B1 array and read back B2
var b1 = byte[] =[0x01,0x02];
var b2 = byte[] =[2];

duelink.Spi.WriteRead(b1,b2);

---

Serial (UART)

Read and write serial data.

Function	Description
SerCfg(baud, rxsize)	Start serial port with baud and allocate a receive buffer of rxsize.
SerRd()	Read a single byte from the receive buffer. Returns zero if it finds no data.
SerRds([data], timeout)	Block the system till all data elements are filled. Terminate and return if no data received in timeout milliseconds. Returns how many bytes it read successfully.
SerWr(byte)	Write a single byte to the serial port.
SerWrs([data])	Write an array of data.
SerB2R()	Returns how many bytes are available in the receive buffer.
SerDisc()	Discard the receive buffer.

The pins used for UART are 1-RX and 2-TX. The DBG pin is an output indicating the sample point, used by us internally.

Serial is handled by software with special internal features. There is also basic hardware UART option available when UART Uplink is not needed, for example on boards with only USB Uplink, such as DueDuino. To activate the hardware UART, use a negative baud in SerCfg(), for example SerCfg(-115200,100). Pins used for hardware UART are 21-TX and 22-RX. We do not support using both hardware and software UARTs simultaneously.

Samples

Script

SerCfg(9600, 1024)

# If there is data, read a byte and write it back
if SerB2R() > 0
  _B = SerRd()
  SerWr(_B)
end

Python

duelink.Uart.Configuration(9600, 1024)

# If there is data, read a byte and write it back
if duelink.Uart.BytesToRead() > 0:
  data = duelink.Uart.ReadByte()
  duelink.Uart.WriteByte(data)

MicroPython

await duelink.Uart.Configuration(9600, 1024)

// If there is data, read a byte and write it back
if (duelink.Uart.BytesToRead() > 0) {
  let data = await duelink.Uart.ReadByte()
  await duelink.Uart.WriteByte(data)
}

JavaScript

duelink.Uart.Configuration(9600, 1024);

// If there is data, read a byte and write it back
if (duelink.Uart.BytesToRead() > 0)
{
  var data = duelink.Uart.ReadByte();
  duelink.Uart.WriteByte(data);
}

.NET

duelink.Uart.Configuration(9600, 1024)

# If there is data, read a byte and write it back
if duelink.Uart.BytesToRead() > 0:
  data = duelink.Uart.ReadByte()
  duelink.Uart.WriteByte(data)

Arduino

duelink.Uart.Configuration(9600, 1024);

// If there is data, read a byte and write it back
if (duelink.Uart.BytesToRead() > 0)
{
  var data = duelink.Uart.ReadByte();
  duelink.Uart.WriteByte(data);
}

---

DMX

Read and write from DMX512 devices. Must call SerCfg(250000, 513) before using these functions. The pins used for DMX are same as UART.

Function	Description
DmxW([channels])	Write channel byte array.
DmxU()	Enable receive to update internal buffer with incoming channels.
DmxRdy()	Returns 1 when there is a frame that was requested by DmxU().
DmxR(channel)	Returns the value of a specific channel.

tip

This feature only support DMX frames with Start Code zero.

Samples

Script

# Enable DMX update on UART pins
DmxU()

# wait until ready
while DmxRdy() = 0
  wait(200)
wend

# Read channel 3
_D = DmxR(3)

Python

duelink.DMX.Update()

# wait until ready
while duelink.DMX.Ready() == 0:
  time.sleep(0.2) 

d = duelink.DMX.Read(3)

MicroPython

await duelink.DMX.Update()

# wait until ready
while (duelink.DMX.Ready() == 0)
  await Util.sleep(200)

let d = await duelink.DMX.Read(3)

JavaScript

duelink.DMX.Update();

// wait until ready
while(duelink.DMX.Ready() == 0)
{
  delay(200);
}
int d = duelink.DMX.Read(3);

.NET

duelink.DMX.Update()

# wait until ready
while duelink.DMX.Ready() == 0:
  time.sleep(0.2) 

d = duelink.DMX.Read(3)

Arduino

duelink.DMX.Update()

// wait until ready
while(duelink.DMX.Ready() == 0)
{
  Thread.Sleep(200) 
}
var d = duelink.DMX.Read(3);

---

Infrared

Receive and decode signals from Infrared remotes. Generate tones. Tx pin must be a PWM capable pin. Rx pin must be an interrupt capable pin.

Function	Description
IrEn(t,r)	Enable IR transmitter on t pin and scanner on r pin. Both pins are optional, use -1 for the pin not being used.
IrRead()	Returns previously received key press value. Returns -1 if no key press was received.
IrWrite(data)	Write data. This is a blocking call.

Samples

Script

# Enable Ir transmit feature on pin 3, no receiver 
IrEn(3, -1)
# Send 0x55
IrWrite(0x55)

Python

# Enable Ir transmit feature on pin 3, no receiver
duelink.Infrared.Enable(3,-1)

duelink.Infrared.Write(0x55)

MicroPython

// Enable Ir transmit feature on pin 3, no receiver
await duelink.Infrared.Enable(3,-1)

await duelink.Infrared.Write(0x55)

JavaScript

// Enable Ir transmit feature on pin 3, no receiver
duelink.Infrared.Enable(3,-1);

duelink.Infrared.Write(0x55);

.NET

# Enable Ir transmit feature on pin 3, no receiver
duelink.Infrared.Enable(3,-1)

duelink.Infrared.Write(0x55)

Arduino

// Enable Ir transmit feature on pin 3, no receiver
duelink.Infrared.Enable(3,-1);

duelink.Infrared.Write(0x55);

---

Temperature

Read temperature from a specific sensor

Function	Description
Temp(pin, type)	Read temperature sensor with type connected to pin. Returns temperature in Celsius.

ID	Type
0	Internal CPU temperature (pin is ignored)
1	DHT11
2	DHT12
3	DHT21
4	DHT22

Samples

Script

# Read DH22 sensor on pin 5
Temp(5,4)

Python

# Read DH22 sensor on pin 5
duelink.Temperature.Read(5, 4)

MicroPython

// Read DH22 sensor on pin 5
await duelink.Temperature.Read(5, 4)

JavaScript

// Read DH22 sensor on pin 5
duelink.Temperature.Read(5, 4);

.NET

# Read DH22 sensor on pin 5
duelink.Temperature.Read(5, 4)

Arduino

// Read DH22 sensor on pin 5
duelink.Temperature.Read(5, 4);

---

Humidity

Read humidity from a specific sensor.

Function	Description
Humid(pin, type)	Read a humidity sensor type connected to pin.

ID	Type
0	reserved
1	DHT11
2	DHT12
3	DHT21
4	DHT22

Samples

Script

# Read DH22 sensor on pin 5
duelink.Humid(5, 4)

Python

# Read DH22 sensor on pin 5
duelink.Humidity.Read(5, 4)

MicroPython

// Read DH22 sensor on pin 5
await duelink.Humidity.Read(5, 4)

JavaScript

// Read DH22 sensor on pin 5
duelink.Humidity.Read(5, 4);

.NET

# Read DH22 sensor on pin 5
duelink.Humidity.Read(5, 4)

Arduino

// Read DH22 sensor on pin 5
duelink.Humidity.Read(5, 4);

---

System Info

Read info about the system.

Function	Description
Info(type)	Returns the a specific type of info!

Type ID	Returned value
0	Product type
1	Firmware version
2	Interface (0: None, 1: I2C, 2: USB, 3: UART)
3	Downlink Mode (see DLMode())

Samples

Script

# Read the firmware version
_v = Info(1)

Python

# Read the firmware version
_v = duelink.System.Info(1)

MicroPython

// Read the firmware version
_v = duelink.System.Info(1)

JavaScript

// Read the firmware version
int _v = duelink.System.Info(1);

.NET

# Read the firmware version
_v = duelink.System.Info(1)

Arduino

// Read the firmware version
var _v = duelink.System.Info(1);

---

Graphics

DUELink firmware include a flexible graphics facilities, detailed on the Graphics Engine page.

---

File System

DUELink firmware include a complete file system facilities, detailed on the File System page.

---

Scheduler

See Scheduler for details.

Function	Description
SStart("func", timeout, count)	Schedule func to run at every timeout (in milliseconds) for count times, or -1 to run forever.
SStat("func")	func: Returns how many times the schedule will still need to run for, 0 is complete and -1 ids forever.
SAbort("func")	func: Abort func scheduler.

Samples

Script

_S = 1

fn Blink()
  _S = ! _S
  DWrite(1,_S)
fend

# Start the scheduler to run Blink 20 times once every 100ms. 
SStart("Blink",100,20)

# Do not terminate
while 1 
  # Do something!
wend

Python

Script only functionality.

MicroPython

Script only functionality.

JavaScript

Script only functionality.

.NET

Script only functionality.

Arduino

Script only functionality.

---

Interrupts

See Interrupts for details.

Function	Description
IStart("func", pin, trigger, pull)	Enable interrupt on pin to trigger func. trigger is: 0 - falling, 1 - rising, 2 - rising and falling. Enable pull: 0 - pull down, 1 - pull up, 2 - no pull.
Istatled("func")	Returns status of interrupt on func: 0- no interrupt, 1- active interrupt.
IAbort("func")	Abort interrupt for func.

Samples

Script

fn Changed()
  PrintLn("Pin was changed!")
fend

# Run "Changed" function when pin 1 goes low
IStart("Changed", 1, 0, 1)


# Do not terminate
while 1 
  # Do something!
wend

Python

Script only functionality.

MicroPython

Script only functionality.

JavaScript

Script only functionality.

.NET

Script only functionality.

Arduino

Script only functionality.

---

Downlink Control

Function	Description
DLMode(mode)	Sets Downlink mode (0:Null, 1: Interface, 2: Host, 3: UART).
DLI2cWr(address, [arrayWrite], [arrayRead])	address: I2C slave address (7 bits) - arrayWrite: array to send, arrayRead: array to read. This only works with DLMode(4).
Cmd("command")	Sends a script command Downlink, only available in DLMode(2) mode, Host mode. You can only to read a float from a function or a variable: _W = Cmd("GetW()") or _W = Cmd("_W"). Setting a remote value is done using cmd(fmt("_x=",_x)).
CmdTmot(t)	Sets t timeout for Cmd() in milliseconds, default 1000ms.

More info are found on the Downlink interface and Daisylink pages.

tip

Use Info() to read the current DLMode() state.

Samples

Script

# Switch Downlink to I2C mode
DLMode(4)
Dim B1[]=[0x11,0x22]
# Write 2 bytes to 0x44 and read nothing
DLI2CWr(0x44,B1,[])

Python

Script only functionality but mode #4 can be accomplished using ExecuteCommand()

duelink.Engine.ExecuteCommand("DLMode(4)")
duelink.Engine.ExecuteCommand("DLI2cWr(0x44, [0x11,0x22], []")

MicroPython

Script only functionality but mode #4 can be accomplished using ExecuteCommand()

await duelink.Engine.ExecuteCommand("DLMode(4)");
await duelink.Engine.ExecuteCommand("DLI2cWr(0x44, [0x11,0x22], []");

JavaScript

Script only functionality but mode #4 can be accomplished using ExecuteCommand()

duelink.Engine.ExecuteCommand("DLMode(4)");
duelink.Engine.ExecuteCommand("DLI2cWr(0x44, [0x11,0x22], []");

.NET

Script only functionality but mode #4 can be accomplished using ExecuteCommand()

duelink.Engine.ExecuteCommand("DLMode(4)")
duelink.Engine.ExecuteCommand("DLI2cWr(0x44, [0x11,0x22], []")

Arduino

Script only functionality but mode #4 can be accomplished using ExecuteCommand()

duelink.Engine.ExecuteCommand("DLMode(4)");
duelink.Engine.ExecuteCommand("DLI2cWr(0x44, [0x11,0x22], []");

---

Device Addressing

These functions are needed for helping with Daisylink devices chained through Downlink connections.

Function	Description
Sel(add, add, add ...)	Select a devices at add in the chain.
GetAdd()	Returns the selected device(s) address.
SetAdd(add)	add Sets the device's address. This command has chain reaction where each device sets the next one. ** Internal function, do not use**

The Sel(add) command accepts multiple addresses. Sel(3,7) will activate the third and and seventh modules in Daisylink. Any command issue from that point forward are executed by both modules. Zero is broadcast address, where Sel(0) will activate all modules. Use GetAdd() to detect what modules are currently active.

Device addressing controls modules on a Daisylink, not a device itself. For that, Sel() can only be issued by the host. Of course, the host can be a third-party board or a DUELink module in host mode.

Samples

Script

# Select device 2
Sel(2)
# Blink the LED on selected device
StatLed(200,200,10)

Python

# Select device 2
duelink.Engine.Select(1)
# Blink the LED on selected device
duelink.System.StatLed(200, 200, 10)

MicroPython

// Select device 2
await duelink.Engine.Select(1);
// Blink the LED on selected device
await duelink.System.StatLed(200, 200, 10);

JavaScript

// Select device 2
duelink.Engine.Select(1);
// Blink the LED on selected device
duelink.System.StatLed(200, 200, 10);

.NET

# Select device 2
duelink.Engine.Select(1)
# Blink the LED on selected device
duelink.System.StatLed(200, 200, 10)

Arduino

// Select device 2
duelink.Engine.Select(1);
// Blink the LED on selected device
duelink.System.StatLed(200, 200, 10);

---

Math

Function	Description
Rnd(max)	Returns a random number with max value.
Cos(rad)	Returns cosine of rad.
Sin(rad)	Returns sine of rad.
Tan(rad)	Returns tangent rad.
Sqrt(number)	Returns square root of number.
Abs(number)	Returns absolute value of a number.
Ceil(number)	Returns ceiling of a number.
Floor(number)	Floor a number.
Round(number)	Round a number.
Trunc(number)	Returns a truncated value number.
IsNaN(number)	Returns 1 number is a valid value.

Samples

Script

# Read a random number between 0 and 10
_R = Rnd(10)

Python

Use Python native facilities.

MicroPython

Use JavaScript native facilities.

JavaScript

Use Arduino native facilities.

.NET

Use MicroPython native facilities.

Arduino

Use .NET native facilities.

---

Converters

Function	Description
SprintF([buffer], format)	Works like sprintf() in the C-language.
Fmt(...)	Returns formatted string for internal functions, takes arguments just like Print().
Hex(num)	Returns the number in hex.
Chr(num)	Returns the ascii char of a number.
Scale(value, fromLow, fromHigh, toLow, toHigh)	Returns a scaled number from value.
Memcpy([dst], offset_dst, [src], offset_src, count)	Used to copy a block of memory from one location to another. [dst] and [src] must be same array type.

Samples

Script

_H = 0x55
# Print the value in its hex representation
PrintLn(Hex(_H))

Python

Use Python native facilities.

MicroPython

Use JavaScript native facilities.

JavaScript

Use Arduino native facilities.

.NET

Use MicroPython native facilities.

Arduino

Use .NET native facilities.

---

Asynchronous IO

Enable Asynchronous IO. Detailed on the Engine main page.

Function	Description
AsIo(enable)	enable: 1 = Enable, 0 = Disable

Samples

Script

AsIo(1) # Enable Asynchronous IO

# The engine will respond even when looping
while 1
# ...do something!
wend

Python

Script only functionality.

MicroPython

Script only functionality.

JavaScript

Script only functionality.

.NET

Script only functionality.

Arduino

Script only functionality.

---

System Reset

Reset or clear the system.

Function	Description
Reset(mode)	Reset the system with mode.

mode	Description
0	System Reset (just like pressing reset button).
1	Wipe out the entire chip (factory reset!). This command must be executed twice for it to take effect.

It is important to keep device addressing under consideration. To do so, Reset(0) will automatically reset all devices, regardless of what device was selected using Sel(). However, Reset(1) will only erase the selected device. We recommend Reset(1):Reset(1) on a singular connected device, or on the first connected device in a daisylink. If you really need, Sel(0):Reset(1):Reset(1) will wipe out every single device in a daisylink!

Samples

Script

# Reset All devices
Sel(0)
Reset(0)

Python

# Reset All devices
duelink.Engine.Select(0)
duelink.System.Reset(0)

MicroPython

// Reset All devices
await duelink.Engine.Select(0)
await duelink.System.Reset(0)

JavaScript

# Reset All devices
duelink.Engine.Select(0);
duelink.System.Reset(0);

.NET

# Reset All devices
duelink.Engine.Select(0)
duelink.System.Reset(0)

Arduino

# Reset All devices
duelink.Engine.Select(0);
duelink.System.Reset(0);

---

Low Power

Function	Description
LowPwr(m, p)	Put the module in m sleep mode, with p pin function.

Sleep Mode	Wake up pin	Description
0	Pins 1 or 3	System shutdown, including the internal RTC. A low-to-high on p pins 1 & 3 will reset the module.
1	Any interrupt-capable pin	System shut down, but keep the internal RTC running. A low-to-high on p pin or an RTC alarm will reset the module.

Setting wake up pin to 0 will disable the GPIO wake up feature.

tip

A module will exit any low power mode after system reset or power cycle.

Samples

Script

# Go to sleep and reset when pin 3 changes from low to high.
LowPwr(0, 2)

Python

Script only functionality.

MicroPython

Script only functionality.

JavaScript

Script only functionality.

.NET

Script only functionality.

Arduino

Script only functionality.

---

One-Time Programmable

Write and read from a special memory type that can be written only once and can never be erased or changed! The size of this special memory region is 512 bytes (64 8-Byte blocks).

Function	Description
OtpR(addr)	Read a single byte from addr.
OtpW(addr, [data])	*STOP Irreversible Action! Write data bytes to addr, where addr must be and data size must be multiple of 8. Returns 1 on success, 0 if failed because an 8 byte block was previously written to.

tip

Use byte arrays. If float array is used then only the first byte of each element is written.

Samples

Script

# Read a value from OTP address 12
OtpR(12)

Python

# Read a value from OTP address 12
duelink.Otp.Read(12)

MicroPython

// Read a value from OTP address 12
await duelink.Otp.Read(12)

JavaScript

// Read a value from OTP address 12
duelink.Otp.Read(12);

.NET

# Read a value from OTP address 12
duelink.Otp.Read(12)

Arduino

// Read a value from OTP address 12
duelink.Otp.Read(12);

---

Coprocessor

A few modules, such as USB Host include a coprocessor. See Coprocessor for more details.

---

RTC

Access clock and date in the internal Real Time Clock (RTC).

Function	Description
RtcW([timedate])	Sets (write) the desired time and date from timedate array in the RTC.
RtcR([timedate])	Read the current time and date into array. If 0 is used instead of array then the rtc value is printed as HH:MM:SS - DD MMM YYYY.

The array used for all RTC functions is 6 bytes, organized as: [Second,minute,hour,day,mon,year]. Values must be proper for their field. For example, there is no 70 seconds in time. Also, year is starting from the year 2000. For year 2025, just use 25. Hours are military 24 hours.

tip

Power loss will cause the internal RTC to lose its value. This is where RTC Module comes in handy.

Samples

Script

# Sets the current time to 18:10:00 27 Feb 2025
Dim b1[6]= [0,10,18,27,2,25]
RtcW(b1)

Dim b2[6]
# Read the time into array
RtcR(b2)
# Show (print) the current time
RtcR(0)

Python

# Sets the current time to 18:10:00 27 Feb 2025
b1 = bytearray([0,10,18,27,2,25])

duelink.Rtc.Write(b1)

# Read the time into array
b2 = bytearray(6)
duelink.Rtc.Read(b2)

MicroPython

// Sets the current time to 18:10:00 27 Feb 2025
let b1 = Uint8Array([0,10,18,27,2,25])

await duelink.Rtc.Write(b1)

// Read the time into array
let b2 = Uint8Array(6)
await duelink.Rtc.Read(b2)

JavaScript

// Sets the current time to 18:10:00 27 Feb 2025
byte[] b1 = {0,10,18,27,2,25};

duelink.Rtc.Write(b1);

// Read the time into array
byte[] b2 = byte[6];
duelink.Rtc.Read(b2);

.NET

# Sets the current time to 18:10:00 27 Feb 2025
b1 = bytearray([0,10,18,27,2,25])

duelink.Rtc.Write(b1)

# Read the time into array
b2 = bytearray(6)
duelink.Rtc.Read(b2)

Arduino

// Sets the current time to 18:10:00 27 Feb 2025
var b1 = new byte[] {0,10,18,27,2,25};

duelink.Rtc.Write(b1);

// Read the time into array
var b2 = new byte[6];
duelink.Rtc.Read(b2);

---

Streams

Streams allows a Supported Hardware to "stream" data out of or in to a device. See Stream page.

---

Misc

Function	Description
Version()	Returns firmware version and device ID in this format: GHI Electronics DUELink v01.03:BB01.
Echo(enable)	Sets local echo functionality(1: Enable, 0: Disable). This is disabled by default.
Len([array])	Returns the length of array.
ReadVCC()	Returns current system voltage.
Exit()	Terminate and exit the script.

Samples

Script

# Read the system's voltage
_V = ReadVCC()

Python

v = duelink.Analog.ReadVcc()

MicroPython

let v = await duelink.Analog.ReadVcc()

JavaScript

float v = duelink.Analog.ReadVcc();

.NET

v = duelink.Analog.ReadVcc()

Arduino

var v = duelink.Analog.ReadVcc();

---

Library Specific

These are library specific functions that are added to help with controlling modules and scripts. These functions do not exist on the script side.

Function	Description
float duelink.Engine.ExecuteCommand("cmd")	Writes a command to a module and returns a float.
string duelink.Engine.ExecuteCommandRaw("cmd")	Writes a command to a module and returns a raw string.

Also, there are other functions to help with accessing the module's internal arrays, see stream.

Samples

Script

Library only functionality.

Python

# Read the module's internal voltage
v = Engine.ExecuteCommand("ReadVCC()")
# Read the value of the script's global variable _X
x = Engine.ExecuteCommand("_X")
# Set the value of the script's global variable _Y to 10
y = 10
Engine.ExecuteCommand(f'_Y={y}')

MicroPython

// Read the module's internal voltage
await v = Engine.ExecuteCommand("ReadVCC()");
// Read the value of the script's global variable _X
await x = Engine.ExecuteCommand("_X");
// Set the value of the script's global variable _Y to 10
var y = 10;
await Engine.ExecuteCommand("_Y=" + y);

JavaScript

// Read the module's internal voltage
float v = Engine.ExecuteCommand("ReadVCC()")
// Read the value of the script's global variable _X
float x = Engine.ExecuteCommand("_X")
// Set the value of the script's global variable _Y to 10
float y = 10
Engine.ExecuteCommand(f'_Y={y}')

.NET

# Read the module's internal voltage
v = Engine.ExecuteCommand("ReadVCC()")
# Read the value of the script's global variable _X
x = Engine.ExecuteCommand("_X")
# Set the value of the script's global variable _Y to 10
y = 10
Engine.ExecuteCommand(f'_Y={y}')

Arduino

// Read the module's internal voltage
var v = Engine.ExecuteCommand("ReadVCC()");
// Read the value of the script's global variable _X
var x = Engine.ExecuteCommand("_X");
// Set the value of the script's global variable _Y to 10
var y = 10;
Engine.ExecuteCommand($'_Y={y}');