customlinux

package
v0.11.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2023 License: AGPL-3.0 Imports: 10 Imported by: 0

README

[EXPERIMENTAL] Configuring a custom Linux board

This component supports a board running Linux and requires the user to provide a map of gpio pin names to the corresponding gpio chip and line number. The mappings should be provided in a json file in this format:

{
  "pins": [
    {
        "name": "string",
        "device_name": "string",
        "line_number": "int",
        "pwm_chip_sysfs_dir": "string",
        "pwm_id": "int"
    }
  ]
}

pwm_chip_sysfs_dir and pwm_id are optional fields. To configure a new board with these mappings, set the pin_config_file_path attribute to the filepath to your json configuration file.

Documentation

Overview

Package customlinux implements a board running Linux. This is an Experimental package

Package customlinux implements a board running Linux

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	BoardDefsFilePath string            `json:"board_defs_file_path"`
	I2Cs              []board.I2CConfig `json:"i2cs,omitempty"`
	SPIs              []board.SPIConfig `json:"spis,omitempty"`
}

A Config describes the configuration of a board and all of its connected parts.

func (*Config) Validate

func (conf *Config) Validate(path string) ([]string, error)

Validate ensures all parts of the config are valid.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL