picommon

Documentation

Overview

Package picommon contains shared information for supported and non-supported pi boards.

Index

• Variables
• func ConvertErrorCodeToMessage(errorCode int, message string) error
• type ServoConfig
  • func (config *ServoConfig) Validate(path string) ([]string, error)

Variables

var ModelName = resource.NewDefaultModel("pi")

ModelName is the name used refer to any implementation of a pi based component.

var PiGPIOErrorMap = map[int]string{}/* 150 elements not displayed */

PiGPIOErrorMap maps the error codes to the human readable error names. This can be found at the pigpio C interface.

Functions

func ConvertErrorCodeToMessage

func ConvertErrorCodeToMessage(errorCode int, message string) error

ConvertErrorCodeToMessage converts error code to a human-readable string.

Types

type ServoConfig

type ServoConfig struct {
	Pin         string   `json:"pin"`
	Min         int      `json:"min,omitempty"`
	Max         int      `json:"max,omitempty"` // specifies a user inputted position limitation
	StartPos    *float64 `json:"starting_position_degs,omitempty"`
	HoldPos     *bool    `json:"hold_position,omitempty"` // defaults True. False holds for 500 ms then disables servo
	BoardName   string   `json:"board"`
	MaxRotation int      `json:"max_rotation_deg,omitempty"` // specifies a hardware position limitation. Defaults to 180
}

ServoConfig is the config for a pi servo.

func (*ServoConfig) Validate

func (config *ServoConfig) Validate(path string) ([]string, error)

Validate ensures all parts of the config are valid.