pico

README

go-pico

This repository contains a tinygo implementation of the Raspberry Pi Pico (RP2040) Microcontroller and everything else you need in order to start developing golang on the RP2040 with tinygo. The support for some SDK features are missing on tinygo, so this is an alternative.

For dependencies and installation, please see INSTALLATION.md.

Versions

This repository currently tracks the following versions:

• Pico SDK 1.4.0
• tinygo 0.24.0

Contributing & Distribution

This repository is currently in development and subject to change.

Please do file feature requests and bugs here.

The license is Apache 2 so feel free to redistribute. Redistributions in either source code or binary form must reproduce the copyright notice, and please link back to this repository for more information:

RP2040 SDK for tinygo

https://github.com/djthorpe/go-pico/

Copyright (c) 2022, David Thorpe, All rights reserved.

Documentation

Index

• type ADC
  • func (a *ADC) Get() uint16
  • func (a *ADC) GetTemperature() float32
  • func (a *ADC) GetVoltage(vref float32) float32
• type Mode
• type PWM
  • func (p *PWM) Counter() uint16
  • func (p *PWM) Dec()
  • func (p *PWM) Enabled() bool
  • func (p *PWM) Get(pin Pin) uint16
  • func (p *PWM) Inc()
  • func (p *PWM) Set(pin Pin, level uint16)
  • func (p *PWM) SetCounter(value uint16)
  • func (p *PWM) SetEnabled(enabled bool)
  • func (p *PWM) SetInterrupt(handler PWM_callback_t)
  • func (p *PWM) SetWrap(wrap uint16)
  • func (p *PWM) Wrap() uint16
• type PWM_callback_t
• type Pin
  • func (p Pin) ADC() *ADC
  • func (p Pin) Get() bool
  • func (p Pin) Mode() Mode
  • func (p Pin) PWM() *PWM
  • func (p Pin) Set(value bool)
  • func (p Pin) SetInterrupt(callback Pin_callback_t)
  • func (p Pin) SetMode(mode Mode) error
• type Pin_callback_t
• type State

Types

type ADC

type ADC struct {
	// contains filtered or unexported fields
}

func (*ADC) Get

func (a *ADC) Get() uint16

Get returns the raw ADC value, which is the first 12 bits

func (*ADC) GetTemperature

func (a *ADC) GetTemperature() float32

Return temperature ReadTemperature does a one-shot sample of the internal temperature sensor and returns a celsius reading.

Only works on the channel. Other channels will return 0

func (*ADC) GetVoltage

func (a *ADC) GetVoltage(vref float32) float32

Return voltage given the value of the reference voltage

type Mode

type Mode uint8

const (
	ModeOutput Mode = iota
	ModeInput
	ModeInputPulldown
	ModeInputPullup
	ModeUART
	ModePWM
	ModeI2C
	ModeSPI
	ModeOff
)

type PWM

type PWM struct {
	// contains filtered or unexported fields
}

func (*PWM) Counter

func (p *PWM) Counter() uint16

Get counter value

func (*PWM) Dec

func (p *PWM) Dec()

Decrement counter

func (*PWM) Enabled

func (p *PWM) Enabled() bool

func (*PWM) Get

func (p *PWM) Get(pin Pin) uint16

Get level

func (*PWM) Inc

func (p *PWM) Inc()

Increment counter

func (*PWM) Set

func (p *PWM) Set(pin Pin, level uint16)

Set level

func (*PWM) SetCounter

func (p *PWM) SetCounter(value uint16)

Set counter value

func (*PWM) SetEnabled

func (p *PWM) SetEnabled(enabled bool)

func (*PWM) SetInterrupt

func (p *PWM) SetInterrupt(handler PWM_callback_t)

Set interrupt handler

If called with nil then handler is disabled

func (*PWM) SetWrap

func (p *PWM) SetWrap(wrap uint16)

Set wrapping value

func (*PWM) Wrap

func (p *PWM) Wrap() uint16

Get wrapping value

type PWM_callback_t

type PWM_callback_t func(pwm *PWM)

type Pin

type Pin uint

func (Pin) ADC

func (p Pin) ADC() *ADC

Get ADC for pin

func (Pin) Get

func (p Pin) Get() bool

Get pin state

func (Pin) Mode

func (p Pin) Mode() Mode

Get pin mode

func (Pin) PWM

func (p Pin) PWM() *PWM

Get PWM for pin

func (Pin) Set

func (p Pin) Set(value bool)

Set pin state

func (Pin) SetInterrupt

func (p Pin) SetInterrupt(callback Pin_callback_t)

Set pin interrupt

func (Pin) SetMode

func (p Pin) SetMode(mode Mode) error

Set pin mode

type Pin_callback_t

type Pin_callback_t func(Pin)

type State

type State uint8

const (
	StateLow State = (1 << iota)
	StateHigh
	StateFall
	StateRise
	StateNone State = 0
	StateMax        = StateRise
)