From cd992bd7d69321e6d47c95393ef38bdf69737636 Mon Sep 17 00:00:00 2001
From: Ron Evans <ron@hybridgroup.com>
Date: Wed, 24 Apr 2019 10:57:30 +0200
Subject: [PATCH] bmp180: change method names/signature for obtaining
 temperature and pressure uniform with other similar drivers

Signed-off-by: Ron Evans <ron@hybridgroup.com>
---
 README.md               |  4 ++--
 bmp180/bmp180.go        | 17 +++++++++--------
 drivers.go              |  4 ++--
 examples/bmp180/main.go |  7 ++++---
 4 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index f5fb7ba..72111e8 100644
--- a/README.md
+++ b/README.md
@@ -39,10 +39,10 @@ func main() {
     println("BMP180 detected")
 
     for {
-        temp, _ := sensor.Temperature()
+        temp, _ := sensor.ReadTemperature()
         println("Temperature:", float32(temp)/1000, "ºC")
 
-        pressure, _ := sensor.Pressure()
+        pressure, _ := sensor.ReadPressure()
         println("Pressure", float32(pressure)/100000, "hPa")
 
         time.Sleep(2 * time.Second)
diff --git a/bmp180/bmp180.go b/bmp180/bmp180.go
index 47afc69..bafde27 100644
--- a/bmp180/bmp180.go
+++ b/bmp180/bmp180.go
@@ -1,5 +1,5 @@
 // Package bmp180 provides a driver for the BMP180 digital pressure sensor
-// by Bosch
+// by Bosch.
 //
 // Datasheet:
 // https://cdn-shop.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf
@@ -12,7 +12,7 @@ import (
 	"machine"
 )
 
-// BMP180OversamplingMode is the oversampling ratio of the pressure measurement.
+// OversamplingMode is the oversampling ratio of the pressure measurement.
 type OversamplingMode uint
 
 // calibrationCoefficients reads at startup and stores the calibration coefficients
@@ -41,7 +41,8 @@ type Device struct {
 // New creates a new BMP180 connection. The I2C bus must already be
 // configured.
 //
-// This function only creates the Device object, it does not touch the device.
+// This function only creates the Device object, it does not initialize the device.
+// You must call Configure() first in order to use the device itself.
 func New(bus machine.I2C) Device {
 	return Device{
 		bus:     bus,
@@ -59,7 +60,7 @@ func (d *Device) Connected() bool {
 }
 
 // Configure sets up the device for communication and
-// read the calibration coefficientes.
+// read the calibration coefficients.
 func (d *Device) Configure() {
 	data := make([]byte, 22)
 	err := d.bus.ReadRegister(uint8(d.Address), AC1_MSB, data)
@@ -79,8 +80,8 @@ func (d *Device) Configure() {
 	d.calibrationCoefficients.md = readInt(data[20], data[21])
 }
 
-// Temperature returns the temperature in celsius milli degrees (ºC/1000)
-func (d *Device) Temperature() (temperature int32, err error) {
+// ReadTemperature returns the temperature in celsius milli degrees (ºC/1000).
+func (d *Device) ReadTemperature() (temperature int32, err error) {
 	rawTemp, err := d.rawTemp()
 	if err != nil {
 		return
@@ -90,8 +91,8 @@ func (d *Device) Temperature() (temperature int32, err error) {
 	return 100 * t, nil
 }
 
-// Pressure returns the pressure in milli pascals (mPa)
-func (d *Device) Pressure() (pressure int32, err error) {
+// ReadPressure returns the pressure in milli pascals (mPa).
+func (d *Device) ReadPressure() (pressure int32, err error) {
 	rawTemp, err := d.rawTemp()
 	if err != nil {
 		return
diff --git a/drivers.go b/drivers.go
index b0181e7..6b1969d 100644
--- a/drivers.go
+++ b/drivers.go
@@ -25,10 +25,10 @@
 //		println("BMP180 detected")
 //
 //		for {
-//			temp, _ := sensor.Temperature()
+//			temp, _ := sensor.ReadTemperature()
 //			println("Temperature:", float32(temp)/1000, "ºC")
 //
-//			pressure, _ := sensor.Pressure()
+//			pressure, _ := sensor.ReadPressure()
 //			println("Pressure", float32(pressure)/100000, "hPa")
 //
 //			time.Sleep(2 * time.Second)
diff --git a/examples/bmp180/main.go b/examples/bmp180/main.go
index 61da0af..595ff07 100644
--- a/examples/bmp180/main.go
+++ b/examples/bmp180/main.go
@@ -3,8 +3,9 @@ package main
 import (
 	"time"
 
-	"github.com/tinygo-org/drivers/bmp180"
 	"machine"
+
+	"github.com/tinygo-org/drivers/bmp180"
 )
 
 func main() {
@@ -20,10 +21,10 @@ func main() {
 	println("BMP180 detected")
 
 	for {
-		temp, _ := sensor.Temperature()
+		temp, _ := sensor.ReadTemperature()
 		println("Temperature:", float32(temp)/1000, "ºC")
 
-		pressure, _ := sensor.Pressure()
+		pressure, _ := sensor.ReadPressure()
 		println("Pressure", float32(pressure)/100000, "hPa")
 
 		time.Sleep(2 * time.Second)