j5.boards package

Submodules

j5.boards.base module

The base classes for boards and group of boards.

class j5.boards.base.Board[source]

Bases: object

A collection of hardware that has an implementation.

BOARDS = []
static discover(backend: j5.backends.base.Backend) → List[j5.boards.base.Board][source]

Detect and return a list of boards of this type.

firmware_version

The firmware version of the board.

static make_all_safe() → None[source]

Make all boards safe.

make_safe() → None[source]

Make all components on this board safe.

name

A human friendly name for this board.

serial

The serial number of the board.

static supported_components() → List[Type[Component]][source]

The types of component supported by this board.

class j5.boards.base.BoardGroup(board: j5.boards.base.Board, backend: j5.backends.base.Backend)[source]

Bases: object

A group of boards that can be accessed.

make_safe() → None[source]

Make all of the boards safe.

singular() → j5.boards.base.Board[source]

If there is only a single board in the group, return that board.

update_boards() → None[source]

Update the boards in this group to see if new boards have been added.

Module contents

This module contains the boards that we support.

class j5.boards.Board[source]

Bases: object

A collection of hardware that has an implementation.

BOARDS = []
static discover(backend: j5.backends.base.Backend) → List[j5.boards.base.Board][source]

Detect and return a list of boards of this type.

firmware_version

The firmware version of the board.

static make_all_safe() → None[source]

Make all boards safe.

make_safe() → None[source]

Make all components on this board safe.

name

A human friendly name for this board.

serial

The serial number of the board.

static supported_components() → List[Type[Component]][source]

The types of component supported by this board.

class j5.boards.BoardGroup(board: j5.boards.base.Board, backend: j5.backends.base.Backend)[source]

Bases: object

A group of boards that can be accessed.

make_safe() → None[source]

Make all of the boards safe.

singular() → j5.boards.base.Board[source]

If there is only a single board in the group, return that board.

update_boards() → None[source]

Update the boards in this group to see if new boards have been added.