robocar-pca9685/vendor/periph.io/x/devices/v3/pca9685/pins.go

149 lines
2.8 KiB
Go

// Copyright 2020 The Periph Authors. All rights reserved.
// Use of this source code is governed under the Apache License, Version 2.0
// that can be found in the LICENSE file.
package pca9685
import (
"errors"
"fmt"
"time"
"periph.io/x/conn/v3/gpio"
"periph.io/x/conn/v3/gpio/gpioreg"
"periph.io/x/conn/v3/physic"
gpiopin "periph.io/x/conn/v3/pin"
)
const (
dutyMax gpio.Duty = 1<<12 - 1
)
type pin struct {
dev *Dev
channel int
}
// CreatePin creates a gpio handle for the given channel.
func (d *Dev) CreatePin(channel int) (gpio.PinIO, error) {
err := verifyChannel(channel)
if err != nil {
return nil, err
}
return &pin{
dev: d,
channel: channel,
}, nil
}
// RegisterPins makes PWM channels available as PWM pins in the pin registry
//
// Pin names have the following format: PCA9685_<HexAddress>_<channel> (e.g. PCA9685_40_11)
func (d *Dev) RegisterPins() error {
for i := 0; i < 16; i++ {
pin, err := d.CreatePin(i)
if err != nil {
return err
}
if err = gpioreg.Register(pin); err != nil {
return err
}
}
return nil
}
// UnregisterPins remove all previously created pin handles of this device from the GPIO registry
func (d *Dev) UnregisterPins() error {
for i := 0; i < 16; i++ {
err := gpioreg.Unregister(d.pinName(i))
if err != nil {
return err
}
}
return nil
}
func (p *pin) String() string {
return p.Name()
}
func (p *pin) Halt() error {
return p.Out(gpio.Low)
}
func (d *Dev) pinName(channel int) string {
return fmt.Sprintf("PCA9685_%x_%d", d.dev.Addr, channel)
}
func (p *pin) Name() string {
return p.dev.pinName(p.channel)
}
func (p *pin) Number() int {
return p.channel
}
func (p *pin) Function() string {
return string(p.Func())
}
func (p *pin) In(pull gpio.Pull, edge gpio.Edge) error {
return errors.New("PCA9685: Pin cannot be configured as input")
}
func (p *pin) Read() gpio.Level {
return gpio.INVALID.Read()
}
func (p *pin) WaitForEdge(timeout time.Duration) bool {
return false
}
func (p *pin) Pull() gpio.Pull {
return gpio.Float
}
func (p *pin) DefaultPull() gpio.Pull {
return gpio.Float
}
func (p *pin) Out(l gpio.Level) error {
return p.PWM(gpio.DutyMax, 0)
}
func (p *pin) PWM(duty gpio.Duty, freq physic.Frequency) error {
if err := p.dev.SetPwmFreq(freq); err != nil {
return err
}
if duty == gpio.DutyMax {
return p.dev.SetFullOn(p.channel)
}
if duty == 0 {
return p.dev.SetFullOff(p.channel)
}
// PWM duty scaled down from 24 to 12 bits
scaled := duty >> 12
if scaled > dutyMax {
scaled = dutyMax
}
return p.dev.SetPwm(p.channel, 0, scaled)
}
func (p *pin) Func() gpiopin.Func {
return gpio.PWM
}
func (p *pin) SupportedFuncs() []gpiopin.Func {
return []gpiopin.Func{gpio.PWM}
}
func (p *pin) SetFunc(f gpiopin.Func) error {
if f != gpio.PWM {
return fmt.Errorf("PCA9685: Function not supported: %s", f)
}
return nil
}