UniDev Reference

Initializes the UniDev instance, creating the NeoPixel object and setting pin modes. But it is not necessary to call this function, because it is called automatically when the UniDev object is created.

Example

UniDev module;
void setup() {
    module.begin();
}

Reads distance from an ultrasonic sensor (HC-SR04).

Parameters

• trig: Trigger pin (P1-P8)
• echo: Echo pin (P1-P8)

Returns

Distance in millimeters.

Example

int dist = module.ultraSonic(P6, P7);
if (dist < 100) {
    // Obstacle detected
}

Reads an analog value from a line sensor.

Parameters

• port: Sensor port definition (P1-P8).

Returns

Analog value (0-4095).

Example

int val = module.lineSensor(P3);

Reads a generic digital value from a port.

Parameters

• port: Port definition (P1-P8).

Returns

0 (LOW) or 1 (HIGH).

Example

if (module.digitalSensor(P5) == 1) {
    // Sensor Active
}

Reads a generic analog value from a port.

Parameters

• port: Port definition (P1-P8).

Returns

Analog value (0-4095).

Example

int lightLevel = module.analogSensor(P4);

Returns the current configured mode of a GPIO pin.

Returns

OUTPUT, INPUT, INPUT_PULLUP, INPUT_PULLDOWN, or -1 on error.

Example

int mode = module.getPinMode(P2);

Blocking function that halts program execution until the specified button is pressed and released.

Parameters

• port: Port where button is connected (e.g., P5).

Example

// Wait for button press
module.waitButton(P5);

Checks if a button is currently pressed.

Returns

true if pressed, false otherwise.

Example

if (module.getButtonState(P5)) {
    Serial.println("Button Pressed!");
}

Sets the angle of a servo motor connected to the specified port.

Parameters

• port: The port the servo is connected to (e.g. P1).
• angle: Target angle in degrees (0–180).

Example

module.servo(P3, 0);   // Home position
module.servo(P3, 90);  // Centre position
module.servo(P3, 180); // End position

Pre-attaches a servo to a port and reserves a PWM channel without setting an angle. Optional — servo() attaches automatically on first call. Useful when you want to claim the channel before the first movement.

Parameters

• port: The port the servo is connected to (e.g. P3).

Example

module.servoAttach(P3); // Reserve PWM channel early
module.servo(P3, 90);   // Then use it

Detaches a servo from its port — PWM pulses stop and the motor goes limp. Use this to protect the servo when the mechanism is forced against a stop or carrying a load. The next servo() call re-attaches it automatically.

Parameters

• port: The port the servo is on (e.g. P3).

Example

module.servo(P3, 90);    // Move to position
delay(1000);
module.servoDetach(P3);  // Release — servo goes limp

Sets the color of a single pixel.

Parameters

• index: LED index (0-23).
• r, g, b: Color components (0-255).

Example

// Set 1st LED to Blue
module.pixel(0, 0, 0, 255);

Sets all LEDs in the ring to the specified RGB color. Implicitly calls show().

Example

module.pixelsAll(255, 0, 0); // All Red

Turns off all LEDs.

Example

module.pixelsClear();

Sends the current buffer to the LED strip.

Example

module.pixelsShow();

Sets the global brightness scaling.

Parameters

• brightness: from 0 to 100.

Example

module.pixelsBrightness(50); // Dim the LEDs

Displays a rotating rainbow animation.

Parameters

• speed: Speed of rotation (0-100). Higher values mean faster rotation.
• duration: Total duration of the animation in milliseconds.

Example

module.pixelsRainbow(50, 2000); // 2 seconds

Running light effect: a single pixel moves around the ring once.

Parameters

• r, g, b: Color of the running pixel (0-255).
• duration: Time in milliseconds to complete one full circle.

Example

module.pixelsRunning(255, 0, 0, 1000); // Red pixel circles in 1s

Smoothly fades the LEDs up and down (breathing effect).

Parameters

• r, g, b: Target color at maximum brightness (0-255).
• duration: Total duration of one full breath cycle (fade in + fade out) in milliseconds.

Example

module.pixelsBreathing(0, 0, 255, 3000); // Blue breath over 3s

Gradually fills the ring with color, then gradually clears it.

Parameters

• r, g, b: Fill color (0-255).
• duration: Total duration for the fill AND clear sequence in milliseconds.

Example

module.pixelsFill(0, 255, 0, 1000); // Green fill+clear in 1s

Randomly flashes individual pixels.

Parameters

• r, g, b: Color of the sparkles (0-255).
• duration: Total duration of the effect in milliseconds.
• count: Number of sparkles to generate within that duration.

Example

module.pixelsSparkle(255, 255, 255, 2000, 20); // 20 white flashes in 2s

Rotates a segment of lit LEDs around the ring multiple times.

Parameters

• r, g, b: Color of the segment (0-255).
• duration: Total duration for ALL rotations in milliseconds.
• segmentLength: Number of LEDs in the rotating segment (e.g., 5).
• rotations: Number of full 360-degree turns to complete.

Example

// Rotate a segment of 5 red LEDs 3 times over 2 seconds
module.pixelsRotating(255, 0, 0, 2000, 5, 3);

A spinner animation that lights up one pixel at a time until the ring is full, then restarts.

Parameters

• r, g, b: Color of the spinner (0-255).
• duration: Time in milliseconds for one full rotation.

Example

module.pixelsSpinner(255, 255, 0, 1000);

Sets the traffic light module state.

Parameters

• color: TRAFFIC_RED, TRAFFIC_YELLOW, TRAFFIC_GREEN, or TRAFFIC_OFF.

Example

module.setTrafficLight(TRAFFIC_GREEN);

Runs a standard standard traffic light sequence (Green -> Yellow -> Red -> Yellow -> Green).

Example

module.trafficLightSequence();