doc: update links to release or tagged branch (#1069)

hybridgroup · Feb 13, 2024 · 27d0b21 · 27d0b21
1 parent d76143c
commit 27d0b21
Show file tree

Hide file tree

Showing 47 changed files with 116 additions and 118 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,8 +29,7 @@ Descriptions for each of these will eventually be provided below.
 
 ## General Guidelines
 
-* All active development is in the `dev` branch. New or updated features must be added to the `dev` branch. Hotfixes
-  will be considered on the `master` branch in situations where it does not alter behavior or features, only fixes a bug.
+* All active development is in the `dev` branch. New or updated features must be added to the `dev` branch.
 * All patches must be provided under the Apache 2.0 License
 * Please use the -S option in git to "sign off" that the commit is your work and you are providing it under the
   Apache 2.0 License
@@ -142,4 +141,4 @@ Gobot is released with a Contributor Code of Conduct. By participating in this p
 
 ## Origins
 
-This document is based on the original [io.js contribution guidelines](https://github.com/nodejs/io.js/blob/master/CONTRIBUTING.md)
+This document is based on the original [io.js contribution guidelines](https://github.com/nodejs/io.js/blob/main/CONTRIBUTING.md)
diff --git a/README.md b/README.md
diff --git a/api/basic_auth.go b/api/basic_auth.go
@@ -8,7 +8,7 @@ import (
 
 // BasicAuth returns basic auth handler.
 func BasicAuth(username, password string) http.HandlerFunc {
-	// Inspired by https://github.com/codegangsta/martini-contrib/blob/master/auth/
+	// Inspired by https://github.com/codegangsta/martini-contrib/tree/v0.1/auth
 	return func(res http.ResponseWriter, req *http.Request) {
 		if !secureCompare(req.Header.Get("Authorization"),
 			"Basic "+base64.StdEncoding.EncodeToString([]byte(username+":"+password)),

diff --git a/drivers/aio/doc.go b/drivers/aio/doc.go
@@ -6,6 +6,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For further information refer to aio README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/aio/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/aio/README.md
 */
 package aio // import "gobot.io/x/gobot/v2/drivers/aio"
diff --git a/drivers/ble/sphero/doc.go b/drivers/ble/sphero/doc.go
@@ -2,8 +2,8 @@
 Package sphero provides the Gobot drivers for the Sphero BLE based platforms.
 
 For further information refer to sphero readme files:
-https://github.com/hybridgroup/gobot/blob/master/platforms/sphero/bb8/README.md
-https://github.com/hybridgroup/gobot/blob/master/platforms/sphero/ollie/README.md
-https://github.com/hybridgroup/gobot/blob/master/platforms/sphero/sprkplus/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/bb8/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/ollie/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/sprkplus/README.md
 */
 package sphero // import "gobot.io/x/gobot/v2/drivers/ble/sphero"
diff --git a/drivers/common/spherocommon/spherocommon_packets.go b/drivers/common/spherocommon/spherocommon_packets.go
@@ -1,7 +1,8 @@
 package spherocommon
 
 // LocatorConfig provides configuration for the Location api.
-// https://github.com/orbotix/DeveloperResources/blob/master/docs/Sphero_API_1.50.pdf
+// For more information refer to the api specification of "Orbotix Communication API"
+// see also: http://wiki.mark-toma.com/view/Sphero_API_Tutorial
 // The current (X,Y) coordinates of Sphero on the ground plane in centimeters.
 type LocatorConfig struct {
 	// Determines whether calibrate commands automatically correct the yaw tare value
@@ -15,8 +16,8 @@ type LocatorConfig struct {
 }
 
 // CollisionConfig provides configuration for the collision detection alogorithm.
-// For more information refer to the official api specification
-// https://github.com/orbotix/DeveloperResources/blob/master/docs/Collision%20detection%201.2.pdf.
+// For more information refer to the api specification of "Orbotix Communication API"
+// see also: http://wiki.mark-toma.com/view/Sphero_API_Tutorial
 type CollisionConfig struct {
 	// Detection method type to use. Methods 01h and 02h are supported as
 	// of FW ver 1.42. Use 00h to completely disable this service.
@@ -39,8 +40,8 @@ type CollisionConfig struct {
 }
 
 // DataStreamingConfig provides configuration for Sensor Data Streaming.
-// For more information refer to the official api specification
-// https://github.com/orbotix/DeveloperResources/blob/master/docs/Sphero_API_1.50.pdf page 28
+// For more information refer to the api specification of "Orbotix Communication API"
+// see also: http://wiki.mark-toma.com/view/Sphero_API_Tutorial
 type DataStreamingConfig struct {
 	// Divisor of the maximum sensor sampling rate
 	N uint16

diff --git a/drivers/gpio/doc.go b/drivers/gpio/doc.go
@@ -6,6 +6,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For further information refer to gpio README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/gpio/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/gpio/README.md
 */
 package gpio // import "gobot.io/x/gobot/v2/drivers/gpio"
diff --git a/drivers/i2c/doc.go b/drivers/i2c/doc.go
@@ -6,6 +6,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For further information refer to i2c README:
-https://github.com/hybridgroup/gobot/blob/master/drivers/i2c/README.md
+https://github.com/hybridgroup/gobot/blob/release/drivers/i2c/README.md
 */
 package i2c // import "gobot.io/x/gobot/v2/drivers/i2c"
diff --git a/drivers/i2c/grovepi_driver.go b/drivers/i2c/grovepi_driver.go
@@ -14,7 +14,7 @@ const grovePiDefaultAddress = 0x04
 
 // commands, see:
 // * https://www.dexterindustries.com/GrovePi/programming/grovepi-protocol-adding-custom-sensors/
-// * https://github.com/DexterInd/GrovePi/blob/master/Script/multi_grovepi_installer/grovepi4.py
+// * https://github.com/DexterInd/GrovePi/tree/1.3.0/Script/multi_grovepi_installer/grovepi4.py
 const (
 	commandReadDigital         = 1
 	commandWriteDigital        = 2
@@ -30,7 +30,7 @@ const (
 // https://www.dexterindustries.com/grovepi/
 //
 // To use this driver with the GrovePi, it must be running the firmware >= 1.4.0 and the system version >=3.
-// https://github.com/DexterInd/GrovePi/blob/master/README.md
+// https://github.com/DexterInd/GrovePi/tree/1.3.0/README.md
 type GrovePiDriver struct {
 	*Driver
 	pins map[int]string

diff --git a/drivers/i2c/mpl115a2_driver_test.go b/drivers/i2c/mpl115a2_driver_test.go
@@ -51,7 +51,7 @@ func TestMPL115A2ReadData(t *testing.T) {
 	//   * shift the temperature value right for 6 bits (resolution is 10 bit)
 	//   * shift the pressure value right for 6 bits (resolution is 10 bit)
 	// * calculate temperature in °C according to this implementation:
-	//   https://github.com/adafruit/Adafruit_MPL115A2/blob/master/Adafruit_MPL115A2.cpp
+	//   https://github.com/adafruit/Adafruit_MPL115A2/tree/2.0.2/Adafruit_MPL115A2.cpp
 	//
 	// arrange
 	d, a := initTestMPL115A2DriverWithStubbedAdaptor()

diff --git a/drivers/i2c/sht2x_driver.go b/drivers/i2c/sht2x_driver.go
@@ -43,16 +43,16 @@ const (
 	//  Power on default is 0/0
 	SHT2xAccuracyHigh = byte(0x00)
 
-	// SHT2xTriggerTempMeasureHold is the command for measureing temperature in hold master mode
+	// SHT2xTriggerTempMeasureHold is the command for measuring temperature in hold controller mode
 	SHT2xTriggerTempMeasureHold = 0xe3
 
-	// SHT2xTriggerHumdMeasureHold is the command for measureing humidity in hold master mode
+	// SHT2xTriggerHumdMeasureHold is the command for measuring humidity in hold controller mode
 	SHT2xTriggerHumdMeasureHold = 0xe5
 
-	// SHT2xTriggerTempMeasureNohold is the command for measureing humidity in no hold master mode
+	// SHT2xTriggerTempMeasureNohold is the command for measuring humidity in no hold controller mode
 	SHT2xTriggerTempMeasureNohold = 0xf3
 
-	// SHT2xTriggerHumdMeasureNohold is the command for measureing humidity in no hold master mode
+	// SHT2xTriggerHumdMeasureNohold is the command for measuring humidity in no hold controller mode
 	SHT2xTriggerHumdMeasureNohold = 0xf5
 
 	// SHT2xWriteUserReg is the command for writing user register

diff --git a/drivers/serial/doc.go b/drivers/serial/doc.go
@@ -2,6 +2,6 @@
 Package serial provides Gobot drivers for Serial Port communication based devices.
 
 For further information refer to readme:
-https://github.com/hybridgroup/gobot/blob/master/drivers/serial/README.md
+https://github.com/hybridgroup/gobot/blob/release/drivers/serial/README.md
 */
 package serial // import "gobot.io/x/gobot/v2/drivers/serial"
diff --git a/drivers/spi/doc.go b/drivers/spi/doc.go
@@ -6,6 +6,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For further information refer to spi README:
-https://github.com/hybridgroup/gobot/blob/master/drivers/spi/README.md
+https://github.com/hybridgroup/gobot/blob/release/drivers/spi/README.md
 */
 package spi // import "gobot.io/x/gobot/v2/drivers/spi"
diff --git a/platforms/audio/doc.go b/platforms/audio/doc.go
@@ -2,6 +2,6 @@
 Package audio provides the Gobot adaptor for audio.
 
 For more information refer to the README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/audio/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/audio/README.md
 */
 package audio // import "gobot.io/x/gobot/v2/platforms/audio"
diff --git a/platforms/beaglebone/doc.go b/platforms/beaglebone/doc.go
@@ -42,6 +42,6 @@ Example:
 	}
 
 For more information refer to the beaglebone README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/beaglebone/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/beaglebone/README.md
 */
 package beaglebone // import "gobot.io/x/gobot/v2/platforms/beaglebone"
diff --git a/platforms/bleclient/doc.go b/platforms/bleclient/doc.go
@@ -2,6 +2,6 @@
 Package bleclient provides the Gobot client adaptor for Bluetooth LE.
 
 For more information refer to the README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/bleclient/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/bleclient/README.md
 */
 package bleclient // import "gobot.io/x/gobot/v2/platforms/bleclient"
diff --git a/platforms/chip/doc.go b/platforms/chip/doc.go
@@ -2,6 +2,6 @@
 Package chip contains the Gobot adaptor for the CHIP and CHIP Pro
 
 For further information refer to the chip README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/chip/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/chip/README.md
 */
 package chip // import "gobot.io/x/gobot/v2/platforms/chip"
diff --git a/platforms/dexter/dexter.go b/platforms/dexter/dexter.go
@@ -5,6 +5,6 @@ This package currently supports the following robots:
 - GoPiGo3
 
 For further information refer to Dexter README:
-https://gobot.io/x/gobot/v2/blob/master/platforms/dexter/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/dexter/README.md
 */
 package dexter
diff --git a/platforms/digispark/doc.go b/platforms/digispark/doc.go
@@ -44,6 +44,6 @@ Example:
 	}
 
 For further information refer to digispark README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/digispark/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/digispark/README.md
 */
 package digispark // import "gobot.io/x/gobot/v2/platforms/digispark"
diff --git a/platforms/dragonboard/doc.go b/platforms/dragonboard/doc.go
@@ -2,6 +2,6 @@
 Package dragonboard contains the Gobot adaptor for the DragonBoard 410c
 
 For further information refer to the chip README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/dragonboard/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/dragonboard/README.md
 */
 package dragonboard // import "gobot.io/x/gobot/v2/platforms/dragonboard"
diff --git a/platforms/firmata/doc.go b/platforms/firmata/doc.go
@@ -41,6 +41,6 @@ Example:
 	}
 
 For further information refer to firmata readme:
-https://github.com/hybridgroup/gobot/blob/master/platforms/firmata/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/firmata/README.md
 */
 package firmata // import "gobot.io/x/gobot/v2/platforms/firmata"
diff --git a/platforms/intel-iot/curie/README.md b/platforms/intel-iot/curie/README.md
@@ -69,29 +69,27 @@ func main() {
   )
 
   if err := robot.Start(); err != nil {
-		panic(err)
-	}
+    panic(err)
+  }
 }
 ```
 
 ## How to Connect
 
 ### Installing Firmware
 
-You need to flash your Intel Curie with firmware that uses ConfigurableFirmata along with the FirmataCurieIMU plugin. There are 2 versions of this firmware, once that allows connecting using the serial interface, the other using a Bluetooth LE connection.
+You need to flash your Intel Curie with firmware that uses ConfigurableFirmata along with the FirmataCurieIMU plugin.
+There are 2 versions of this firmware, once that allows connecting using the serial interface, the other using a
+Bluetooth LE connection.
 
 To setup your Arduino environment:
 
 - Install the latest Arduino, if you have not done so yet.
 - Install the "Intel Curie Boards" board files using the "Board Manager". You can find it in the Arduino IDE under the
   "Tools" menu. Choose "Boards > Boards Manager".
 - Search for the "Intel Curie Boards" package in the "Boards Manager" dialog, and then install the latest version.
-- Download the ZIP file for the ConfigurableFirmata library. You can download the latest version of the ConfigurableFirmata
-  from here:
-  [https://github.com/firmata/ConfigurableFirmata/archive/master.zip](https://github.com/firmata/ConfigurableFirmata/archive/master.zip)
-  Once you have downloaded ConfigurableFirmata, install it by using the "Library Manager". You can find it in the Arduino
-  IDE under the "Sketch" menu. Choose "Include Library > Add .ZIP Library". Select the ZIP file for the ConfigurableFirmata
-  library that you just downloaded.
+- Follow the [installation instructions](https://github.com/firmata/ConfigurableFirmata#installation) for the
+  ConfigurableFirmata library
 - Download the ZIP file for the FirmataCurieIMU library. You can download the latest version of FirmataCurieIMU from here:
   [https://github.com/intel-iot-devkit/firmata-curie-imu/archive/master.zip](https://github.com/intel-iot-devkit/firmata-curie-imu/archive/master.zip)
 - Once you have downloaded the FirmataCurieIMU library, install it by using the "Library Manager". You can find it in the

diff --git a/platforms/intel-iot/curie/doc.go b/platforms/intel-iot/curie/doc.go
@@ -2,6 +2,6 @@
 Package curie contains the Gobot driver for the Intel Curie IMU.
 
 For further information refer to intel-iot README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/intel-iot/curie/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/intel-iot/curie/README.md
 */
 package curie // import "gobot.io/x/gobot/v2/platforms/intel-iot/curie"
diff --git a/platforms/intel-iot/edison/doc.go b/platforms/intel-iot/edison/doc.go
@@ -2,6 +2,6 @@
 Package edison contains the Gobot adaptor for the Intel Edison.
 
 For further information refer to intel-iot README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/intel-iot/edison/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/intel-iot/edison/README.md
 */
 package edison // import "gobot.io/x/gobot/v2/platforms/intel-iot/edison"
diff --git a/platforms/intel-iot/intel-iot.go b/platforms/intel-iot/intel-iot.go
@@ -6,6 +6,6 @@ This package currently supports the following Intel IoT hardware:
 - Intel Joule developer kit
 
 For further information refer to intel-iot README:
-https://gobot.io/x/gobot/v2/blob/master/platforms/intel-iot/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/intel-iot/README.md
 */
 package inteliot
diff --git a/platforms/intel-iot/joule/doc.go b/platforms/intel-iot/joule/doc.go
@@ -2,6 +2,6 @@
 Package joule contains the Gobot adaptor for the Intel Joule.
 
 For further information refer to intel-iot README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/intel-iot/joule/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/intel-iot/joule/README.md
 */
 package joule // import "gobot.io/x/gobot/v2/platforms/intel-iot/joule"
diff --git a/platforms/jetson/doc.go b/platforms/jetson/doc.go
@@ -2,6 +2,6 @@
 Package jetson contains the Gobot adaptor for the Jetson Nano.
 
 For further information refer to Jetson README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/jetson/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/jetson/README.md
 */
 package jetson // import "gobot.io/x/gobot/v2/platforms/jetson"
diff --git a/platforms/joystick/doc.go b/platforms/joystick/doc.go
@@ -59,6 +59,6 @@ Example:
 	}
 
 For further information refer to joystick README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/joystick/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/joystick/README.md
 */
 package joystick // import "gobot.io/x/gobot/v2/platforms/joystick"
diff --git a/platforms/keyboard/doc.go b/platforms/keyboard/doc.go
@@ -45,6 +45,6 @@ Example:
 	}
 
 For further information refer to keyboard README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/keyboard/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/keyboard/README.md
 */
 package keyboard // import "gobot.io/x/gobot/v2/platforms/keyboard"
diff --git a/platforms/leap/doc.go b/platforms/leap/doc.go
@@ -40,6 +40,6 @@ Example:
 	}
 
 For more information refer to the leap README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/leap/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/leap/README.md
 */
 package leap // import "gobot.io/x/gobot/v2/platforms/leap"
diff --git a/platforms/mavlink/doc.go b/platforms/mavlink/doc.go
@@ -65,6 +65,6 @@ Example:
 	}
 
 For further information refer to mavlink README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/mavlink/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/mavlink/README.md
 */
 package mavlink // import "gobot.io/x/gobot/v2/platforms/mavlink"
diff --git a/platforms/megapi/doc.go b/platforms/megapi/doc.go
@@ -2,6 +2,6 @@
 Package megapi provides the Gobot adaptor for MegaPi.
 
 For more information refer to the README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/megapi/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/megapi/README.md
 */
 package megapi // import "gobot.io/x/gobot/v2/platforms/megapi"
diff --git a/platforms/mqtt/doc.go b/platforms/mqtt/doc.go
@@ -6,6 +6,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For further information refer to mqtt README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/mqtt/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/mqtt/README.md
 */
 package mqtt // import "gobot.io/x/gobot/v2/platforms/mqtt"
diff --git a/platforms/nanopi/doc.go b/platforms/nanopi/doc.go
@@ -2,6 +2,6 @@
 Package nanopi contains the Gobot adaptor for the FriendlyARM NanoPi Boards.
 
 For further information refer to nanopi README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/nanopi/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/nanopi/README.md
 */
 package nanopi // import "gobot.io/x/gobot/v2/platforms/nanopi"
diff --git a/platforms/nats/doc.go b/platforms/nats/doc.go
@@ -5,6 +5,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For further information refer to nats README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/nats/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/nats/README.md
 */
 package nats // import "gobot.io/x/gobot/v2/platforms/nats"
diff --git a/platforms/opencv/doc.go b/platforms/opencv/doc.go
@@ -40,6 +40,6 @@ Example:
 	}
 
 For further information refer to opencv README:
-https://github.com/hybridgroup/gobot/blob/master/platforms/opencv/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/opencv/README.md
 */
 package opencv // import "gobot.io/x/gobot/v2/platforms/opencv"
diff --git a/platforms/parrot/ardrone/doc.go b/platforms/parrot/ardrone/doc.go
@@ -41,6 +41,6 @@ Example:
 	}
 
 For more information refer to the ardrone README:
-https://github.com/hybridgroup/gobot/tree/master/platforms/parrot/ardrone/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/parrot/ardrone/README.md
 */
 package ardrone // import "gobot.io/x/gobot/v2/platforms/parrot/ardrone"
diff --git a/platforms/parrot/bebop/doc.go b/platforms/parrot/bebop/doc.go
@@ -6,6 +6,6 @@ Installing:
 	Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)
 
 For more information refer to the bebop README:
-https://github.com/hybridgroup/gobot/tree/master/platforms/parrot/bebop/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/parrot/bebop/README.md
 */
 package bebop // import "gobot.io/x/gobot/v2/platforms/parrot/bebop"
diff --git a/platforms/particle/doc.go b/platforms/particle/doc.go
@@ -41,6 +41,6 @@ Example:
 	}
 
 For further information refer to Particle readme:
-https://github.com/hybridgroup/gobot/blob/master/platforms/particle/README.md
+https://github.com/hybridgroup/gobot/blob/release/platforms/particle/README.md
 */
 package particle // import "gobot.io/x/gobot/v2/platforms/particle"