Class MCP23017

This class drives a single MCP23017 GPIO extender

Hierarchy

MCP23017

Index

Constructors

constructor

Methods

Constructors

constructor

new MCP23017(bus: BusInterface, options?: Options): MCP23017

- Defined in index.ts:153
Constructor.

Parameters
- bus: BusInterface
  
  an instance of i2c bus. May be closed at this point
- Default value options: Options = {}
  
  options for the driver.
Returns MCP23017

Methods

handle

handle(handler: InteruptHandler): Promise<void>

- Defined in index.ts:308
Handle interupts received.

Parameters
- handler: InteruptHandler
Returns Promise<void>

init

init(): Promise<void>

- Defined in index.ts:171
Initialize the class

Must be called with an open bus

Returns Promise<void>

read

read(): Promise<number>

- Defined in index.ts:233
Reads the GPIO

Returns Promise<number>

the value of the GPIO Pin in a promise.

readConfigByte

readConfigByte(): Promise<number>

- Defined in index.ts:178
Reads the configuration byte of the chip

Returns Promise<number>

the value of the configuration as a byte in a promise.

register

register(intDefs: InteruptDefinition[], handler?: InteruptHandler): Promise<InteruptHandler>

- Defined in index.ts:254
Register changes to the interupt handling

Parameters
- intDefs: InteruptDefinition[]
- Default value handler: InteruptHandler = {}
Returns Promise<InteruptHandler>

the new interupt handler.

setDirection

setDirection(pins: number, direction: Direction): Promise<void>

- Defined in index.ts:203
Sets the direction of a set of GPI/O pins and eventually pull-up status.

Parameters
- pins: number
- direction: Direction
Returns Promise<void>

a promisse fullfilled when the operation is performed.

setPolarity

setPolarity(pins: number): Promise<void>

- Defined in index.ts:224
Set the polarity of the output (ie XOR with it)

Parameters
- pins: number
Returns Promise<void>

setSeparate

setSeparate(separate: boolean): Promise<void>

- Defined in index.ts:187
Change the way register banks are organize.

Parameters
- separate: boolean
  
  set to true for registers organized as two independent banks and false for interleaved (default)
Returns Promise<void>

a promisse fullfilled when the operation is performed.

write

write(set: number, unset: number): Promise<void>

- Defined in index.ts:241
Modify the GPIO

Parameters
- set: number
- unset: number
Returns Promise<void>

Generated using TypeDoc