summaryrefslogtreecommitdiffstats
path: root/dependencies/pkg/mod/golang.org/x/exp@v0.0.0-20220613132600-b0d781184e0d/io/i2c/driver/driver.go
blob: 3fe51a4f5cdc789f71e4aac0940a727ad6763a35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Copyright 2016 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package driver contains interfaces to be implemented by various I2C implementations.
package driver // import "golang.org/x/exp/io/i2c/driver"

// Opener opens a connection to an I2C device to communicate with
// the I2C address given. If the address is an 10-bit I2C address,
// tenbit is true.
type Opener interface {
	Open(addr int, tenbit bool) (Conn, error)
}

// Conn represents an active connection to an I2C device.
type Conn interface {
	// Tx first writes w (if not nil), then reads len(r)
	// bytes from device into r (if not nil) in a single
	// I2C transaction.
	Tx(w, r []byte) error

	// Close closes the connection.
	Close() error
}