host

Documentation

Overview

Package host defines the host itself.

The host is the machine where this code is running.

Subpackages contain the drivers that are loaded automatically.

Index

• func Init() (*periph.State, error)

Examples

• Init

Functions

func Init

func Init() (*periph.State, error)

Init calls periph.Init() and returns it as-is.

The only difference is that by calling host.Init(), you are guaranteed to have all the drivers implemented in this library to be implicitly loaded.

Example

state, err := Init()
if err != nil {
	log.Fatalf("failed to initialize periph: %v", err)
}
fmt.Printf("Using drivers:\n")
for _, driver := range state.Loaded {
	fmt.Printf("- %s\n", driver)
}
fmt.Printf("Drivers skipped:\n")
for _, failure := range state.Skipped {
	fmt.Printf("- %s: %s\n", failure.D, failure.Err)
}
// Having drivers failing to load may not require process termination. It
// is possible to continue to run in partial failure mode.
fmt.Printf("Drivers failed to load:\n")
for _, failure := range state.Failed {
	fmt.Printf("- %s: %v\n", failure.D, failure.Err)
}

// Use pins, buses, devices, etc.