j5.boards package¶
Submodules¶
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
= {}¶
-
firmware_version
¶ The firmware version of the board.
-
classmethod
get_board_group_from_environment
(environment: j5.backends.backend.Environment) → j5.boards.board.BoardGroup[~T, ~U][T, U][source]¶ Get a board group from an environment.
This method is on Board, rather than BoardGroup for typing purposes.
-
name
¶ A human friendly name for this board.
-
serial
¶ The serial number of the board.
-
-
class
j5.boards.
BoardGroup
(backend_class: Type[U])[source]¶ Bases:
typing.Generic
A group of boards that can be accessed.
-
backend_class
¶ The Backend that this group uses for Boards.
-
boards
¶ Get an unordered list of boards in this group.
-
classmethod
get_board_group
(_: Type[T], backend: Type[U]) → j5.boards.board.BoardGroup[~T, ~U][T, U][source]¶ Get the board group with the given types.
Whilst the first parameter value is not actually used in the function, we need it for typing purposes. This is similar to how a ProxyType works in Haskell.
-