pin

import {pinMode, digitalWrite, digitalRead, analogRead, analogReadMillivolts} from 'mikrojs/pin'

Control GPIO pins for digital and analog I/O.

New to GPIO?

GPIO (General-Purpose Input/Output) pins are physical connections on your microcontroller that you can control from code. Set a pin HIGH to send voltage, LOW to turn it off. Use INPUT mode to read sensors or buttons, OUTPUT mode to drive LEDs or relays.

Functions

pinMode(pin, mode)

Configure a pin's direction.

function pinMode(pin: number, mode: PinMode): Result<void, PinError>

Parameters:

• pin: GPIO pin number
• mode: 'INPUT', 'OUTPUT', or 'INPUT_PULLUP'

pinMode(20, 'OUTPUT').orPanic('Failed to configure pin')

digitalWrite(pin, value)

Set a pin HIGH (1) or LOW (0).

function digitalWrite(pin: number, value: 0 | 1): Result<void, PinError>

digitalWrite(20, 1) // pin HIGH
digitalWrite(20, 0) // pin LOW

digitalRead(pin)

Read the current state of a pin.

function digitalRead(pin: number): 0 | 1

const state = digitalRead(5)
console.log(state ? 'HIGH' : 'LOW')

analogRead(pin, options?)

Read the raw ADC value from a pin.

function analogRead(pin: number, options?: AnalogReadOptions): Result<number, PinError>

Returns a 12-bit integer (0–4095) proportional to the input voltage.

const result = analogRead(2)
if (result.ok) {
  console.log('ADC value:', result.value)
}

analogReadMillivolts(pin, options?)

Read a calibrated voltage from a pin.

function analogReadMillivolts(pin: number, options?: AnalogReadOptions): Result<number, PinError>

Returns the input voltage in millivolts.

const result = analogReadMillivolts(2)
if (result.ok) {
  console.log('Voltage:', result.value, 'mV')
}

Types

PinMode

type PinMode = 'INPUT' | 'OUTPUT' | 'INPUT_PULLUP'

Attenuation

ADC attenuation setting, controls the measurable voltage range.

type Attenuation = '0db' | '2.5db' | '6db' | '11db'

Value	Voltage range
'0db'	0–750 mV
'2.5db'	0–1050 mV
'6db'	0–1300 mV
'11db'	0–2500 mV (default)

AnalogReadOptions

interface AnalogReadOptions {
  attenuation?: Attenuation // default: '11db'
}

Errors

PinError

Variant	Fields	Description
SetModeFailed	message: string	Failed to configure pin mode
WriteFailed	message: string	Failed to write to pin
AdcInitFailed	message: string	Failed to initialize ADC
InvalidAdcPin	—	Pin does not support analog reads