@okee-tech/rppal/index.d.ts

Raspberry Pi peripheral access library for Node.js using `napi-rs` bindings from Rust's `rppal` crate

/* tslint:disable */
/* eslint-disable */

/* auto-generated by NAPI-RS */

export interface PwmConfig {
  frequency: number
  duty: number
  enabled: boolean
}
export const enum Level {
  Low = 0,
  High = 1
}
export const enum Mode {
  Input = 0,
  Output = 1,
  Alt0 = 2,
  Alt1 = 3,
  Alt2 = 4,
  Alt3 = 5,
  Alt4 = 6,
  Alt5 = 7,
  Alt6 = 8,
  Alt7 = 9,
  Alt8 = 10,
  Null = 11
}
export const enum Bias {
  Off = 0,
  PullDown = 1,
  PullUp = 2
}
export declare class Gpio {
  constructor()
  get(pin: number): Pin
}
export declare class Pin {
  get pin(): number
  get value(): Level
  set value(newValue: Level)
  get mode(): Mode
  set mode(newMode: Mode)
  get bias(): Bias
  set bias(newBias: Bias)
  setPwm(frequency: number, duty: number): void
  clearPwm(): void
  get softPwm(): PwmConfig
}
export declare class I2C {
  constructor(bus?: number | undefined | null)
  getCapabilities(): Promise<Capabilities>
  getBus(): Promise<number>
  getClockSpeed(): Promise<number>
  getAddr10Bit(): Promise<boolean>
  setAddr10Bit(newValue: boolean): Promise<void>
  getTimeoutMillis(): Promise<number | null>
  setTimeoutMillis(newValue: number): Promise<void>
  read(address: number, bufferSize?: number | undefined | null): Promise<Array<number>>
  write(address: number, data: Array<number>): Promise<void>
  writeRead(address: number, writeData: Array<number>, readBufferSize?: number | undefined | null): Promise<Array<number>>
  blockRead(address: number, command: number, bufferSize?: number | undefined | null): Promise<Array<number>>
  blockWrite(address: number, command: number, data: Array<number>): Promise<void>
}
export declare class Capabilities {
  get addr10Bit(): boolean
  get i2CBlockRead(): boolean
  get i2CBlockWrite(): boolean
  get smbusQuickCommand(): boolean
  get smbusReceiveByte(): boolean
  get smbusSendByte(): boolean
  get smbusReadByte(): boolean
  get smbusWriteByte(): boolean
  get smbusReadWord(): boolean
  get smbusWriteWord(): boolean
  get smbusProcessCall(): boolean
  get smbusBlockRead(): boolean
  get smbusBlockWrite(): boolean
  get smbusBlockProcessCall(): boolean
  get smbusPec(): boolean
  get smbusHostNotify(): boolean
}