diff --git a/MIGRATION.md b/MIGRATION.md index 88edea9fb..f6c60f9ec 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -7,12 +7,59 @@ a driver or platform with changed API. To prevent this scenario for most users, the main version will not always increased, but affected drivers and platforms are listed here and a migration strategy is provided. -## Switch from version 2.4.0 (applications using the gpiod options affected) +## Switch from version 2.4.0 (applications using the gpiod options and some import paths affected) + +### RockPi adaptor was moved to radxa folder + +For cleanup purposes and future preparation the folders and files were moved. Please search and replace to change the +import path as follows. + +```go +// old +... + "gobot.io/x/gobot/v2/platforms/rockpi" +... + +// new +... + "gobot.io/x/gobot/v2/platforms/radxa/rockpi" +... +``` + +### Tinkerboard adaptors were moved to asus folder + +For cleanup purposes and future preparation the folders and files were moved. Please search and replace to change the +import path as follows. + +```go +// old +... + "gobot.io/x/gobot/v2/platforms/tinkerboard/tinkerboard2" +... + +// new +... + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard2" +... + +``` + +```go +// old +... + "gobot.io/x/gobot/v2/platforms/tinkerboard" +... + +// new +... + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" +... +``` ### NanoPi NEO adaptor was moved to friendlyelec folder With introduce of FriendlyELEC NanoPC-T6 a second adaptor from FriendlyELEC (formerly friendlarm) now exists. Please -search and replace to change the import path as follows. +search and replace to change the import path of nanopi as follows. ```go // old diff --git a/README.md b/README.md index ba94d5cb0..209eb1c46 100644 --- a/README.md +++ b/README.md @@ -242,9 +242,11 @@ Gobot has a extensible system for connecting to hardware devices. The following platforms are currently supported: - [Arduino](http://www.arduino.cc/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/firmata) +- [ASUS Tinker Board](https://www.asus.com/us/Single-Board-Computer/Tinker-Board/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/asus/tinkerboard) +- [ASUS Tinker Board 2](https://tinker-board.asus.com/series/tinker-board-2.html/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/asus/tinkerboard2) - Audio <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/audio) -- [Beaglebone Black](http://beagleboard.org/boards) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/beaglebone) -- [Beaglebone PocketBeagle](http://beagleboard.org/pocket/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/beaglebone) +- [BeagleBoard BeagleBone Black](http://beagleboard.org/boards) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/beagleboard/beaglebone) +- [BeagleBoard PocketBeagle](http://beagleboard.org/pocket/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/beagleboard/pocketbeagle) - [Bluetooth LE](https://www.bluetooth.com/what-is-bluetooth-technology/bluetooth-technology-basics/low-energy) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/bleclient) - [C.H.I.P](http://www.nextthing.co/pages/chip) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/chip) - [C.H.I.P Pro](https://docs.getchip.com/chip_pro.html) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/chip) @@ -275,15 +277,13 @@ platforms are currently supported: - [Parrot Minidrone](https://www.parrot.com/us/minidrones) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/parrot/minidrone) - [Pebble](https://www.getpebble.com/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/pebble) - [PINE64 ROCK64](https://pine64.org/documentation/ROCK64/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/pine64/rock64) -- [Radxa Rock Pi 4](https://wiki.radxa.com/Rock4/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/rockpi) +- [Radxa Rock Pi 4](https://wiki.radxa.com/Rock4/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/radxa/rockpi) - [Raspberry Pi](http://www.raspberrypi.org/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/raspi) - [Serial Port](https://en.wikipedia.org/wiki/Serial_port) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/serialport) - [Sphero](http://www.sphero.com/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/sphero) - [Sphero BB-8](http://www.sphero.com/bb8) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/bb8) - [Sphero Ollie](http://www.sphero.com/ollie) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/ollie) - [Sphero SPRK+](http://www.sphero.com/sprk-plus) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/sphero/sprkplus) -- [Tinker Board](https://www.asus.com/us/Single-Board-Computer/Tinker-Board/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/tinkerboard) -- [Tinker Board 2](https://tinker-board.asus.com/series/tinker-board-2.html/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/tinkerboard/tinkerboard2) - [UP2](http://www.up-board.org/upsquared/) <=> [Package](https://github.com/hybridgroup/gobot/blob/release/platforms/upboard/up2) Support for many devices that use Analog Input/Output (AIO) have a shared set of drivers provided using diff --git a/drivers/aio/README.md b/drivers/aio/README.md index aee953467..cb05aff9f 100644 --- a/drivers/aio/README.md +++ b/drivers/aio/README.md @@ -1,7 +1,7 @@ # AIO This package provides drivers for [Analog Input/Output (AIO)](https://en.wikipedia.org/wiki/Analog-to-digital_converter) -devices. It is normally used by connecting an adaptor such as [BeagleBone](https://gobot.io/documentation/platforms/beaglebone/) +devices. It is normally used by connecting an adaptor such as [BeagleBone](https://gobot.io/documentation/platforms/beagleboard/beaglebone/) that supports the needed interfaces for analog devices. ## Getting Started diff --git a/drivers/i2c/README.md b/drivers/i2c/README.md index ea6e4ba32..9b7761d68 100644 --- a/drivers/i2c/README.md +++ b/drivers/i2c/README.md @@ -1,7 +1,7 @@ # I2C This package provides drivers for [i2c](https://en.wikipedia.org/wiki/I%C2%B2C)devices. It must be used along with an -adaptor such as [Tinker Board](https://gobot.io/documentation/platforms/tinkerboard/) that supports the needed +adaptor such as [Tinker Board](https://gobot.io/documentation/platforms/asus/tinkerboard/) that supports the needed interfaces for i2c devices. ## Getting Started diff --git a/drivers/onewire/README.md b/drivers/onewire/README.md index 6ad8289e5..82455c6eb 100644 --- a/drivers/onewire/README.md +++ b/drivers/onewire/README.md @@ -1,7 +1,7 @@ # 1-wire This package provides drivers for [1-wire](https://en.wikipedia.org/wiki/1-Wire) devices supported by Linux Kernel w1-gpio -drivers. It must be used along with an adaptor such as [Tinker Board](https://gobot.io/documentation/platforms/tinkerboard/) +drivers. It must be used along with an adaptor such as [Tinker Board](https://gobot.io/documentation/platforms/asus/tinkerboard/) that supports the needed interfaces for 1-wire devices. ## Getting Started diff --git a/examples/tinkerboard2_direct_pin_bin_counter.go b/examples/tinkerboard2_direct_pin_bin_counter.go index 044f7ddbd..36e0ed9eb 100644 --- a/examples/tinkerboard2_direct_pin_bin_counter.go +++ b/examples/tinkerboard2_direct_pin_bin_counter.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" "gobot.io/x/gobot/v2/platforms/adaptors" - "gobot.io/x/gobot/v2/platforms/tinkerboard/tinkerboard2" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard2" ) // Wiring diff --git a/examples/tinkerboard2_yl40.go b/examples/tinkerboard2_yl40.go index 79e59fcf4..9fa52f962 100644 --- a/examples/tinkerboard2_yl40.go +++ b/examples/tinkerboard2_yl40.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard/tinkerboard2" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard2" ) func main() { diff --git a/examples/tinkerboard_adafruit1109_lcd_keys.go b/examples/tinkerboard_adafruit1109_lcd_keys.go index acdef3cdd..ba14bbaaf 100644 --- a/examples/tinkerboard_adafruit1109_lcd_keys.go +++ b/examples/tinkerboard_adafruit1109_lcd_keys.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_ads1115.go b/examples/tinkerboard_ads1115.go index 625e01fba..060c6ae11 100644 --- a/examples/tinkerboard_ads1115.go +++ b/examples/tinkerboard_ads1115.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_adxl345.go b/examples/tinkerboard_adxl345.go index 1ddb1c4d7..b86405982 100644 --- a/examples/tinkerboard_adxl345.go +++ b/examples/tinkerboard_adxl345.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_blink.go b/examples/tinkerboard_blink.go index 9a63d61d7..816094284 100644 --- a/examples/tinkerboard_blink.go +++ b/examples/tinkerboard_blink.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) func main() { diff --git a/examples/tinkerboard_bme280.go b/examples/tinkerboard_bme280.go index eca32cc79..ee72572df 100644 --- a/examples/tinkerboard_bme280.go +++ b/examples/tinkerboard_bme280.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_bmp280.go b/examples/tinkerboard_bmp280.go index 721d8e499..10d052b1c 100644 --- a/examples/tinkerboard_bmp280.go +++ b/examples/tinkerboard_bmp280.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_button.go b/examples/tinkerboard_button.go index 8f7067d6b..55b5ce225 100644 --- a/examples/tinkerboard_button.go +++ b/examples/tinkerboard_button.go @@ -11,7 +11,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_direct_pin.go b/examples/tinkerboard_direct_pin.go index 564a17cd8..197f29696 100644 --- a/examples/tinkerboard_direct_pin.go +++ b/examples/tinkerboard_direct_pin.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" "gobot.io/x/gobot/v2/platforms/adaptors" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_ds18b20.go b/examples/tinkerboard_ds18b20.go index 47d0cfdbc..ecdcb790a 100644 --- a/examples/tinkerboard_ds18b20.go +++ b/examples/tinkerboard_ds18b20.go @@ -13,10 +13,10 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/onewire" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) -// Preparation: see /gobot/system/ONEWIRE.md and /gobot/platforms/tinkerboard/README.md +// Preparation: see /gobot/system/ONEWIRE.md and /gobot/platforms/asus/tinkerboard/README.md // // Wiring: // PWR Tinkerboard: 1 (+3.3V, VCC), 6, 9, 14, 20 (GND) diff --git a/examples/tinkerboard_generic.go b/examples/tinkerboard_generic.go index 9410163b5..159fc0c3a 100644 --- a/examples/tinkerboard_generic.go +++ b/examples/tinkerboard_generic.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Attention! Possibly this will not work, because the current kernel of Tinker-OS 4.4.194 (2021-10-06) needs the diff --git a/examples/tinkerboard_grove_lcd.go b/examples/tinkerboard_grove_lcd.go index d7414d136..05ee01d85 100644 --- a/examples/tinkerboard_grove_lcd.go +++ b/examples/tinkerboard_grove_lcd.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) func main() { diff --git a/examples/tinkerboard_hcsr04.go b/examples/tinkerboard_hcsr04.go index 333f54168..123463355 100644 --- a/examples/tinkerboard_hcsr04.go +++ b/examples/tinkerboard_hcsr04.go @@ -14,7 +14,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_hmc5883l.go b/examples/tinkerboard_hmc5883l.go index 86467ff8e..a3b2e62a2 100644 --- a/examples/tinkerboard_hmc5883l.go +++ b/examples/tinkerboard_hmc5883l.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_mfcrc522gpio.go b/examples/tinkerboard_mfcrc522gpio.go index 7843b8fdf..5c79c9a83 100644 --- a/examples/tinkerboard_mfcrc522gpio.go +++ b/examples/tinkerboard_mfcrc522gpio.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/spi" "gobot.io/x/gobot/v2/platforms/adaptors" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_mfcrc522spi.go b/examples/tinkerboard_mfcrc522spi.go index 33d549621..e6db7d786 100644 --- a/examples/tinkerboard_mfcrc522spi.go +++ b/examples/tinkerboard_mfcrc522spi.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/spi" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_motor.go b/examples/tinkerboard_motor.go index 754895446..b4d939584 100644 --- a/examples/tinkerboard_motor.go +++ b/examples/tinkerboard_motor.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_mpl115a2.go b/examples/tinkerboard_mpl115a2.go index b8b967312..7abdccb13 100644 --- a/examples/tinkerboard_mpl115a2.go +++ b/examples/tinkerboard_mpl115a2.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_mpu6050.go b/examples/tinkerboard_mpu6050.go index d7ecbdca9..a69754df8 100644 --- a/examples/tinkerboard_mpu6050.go +++ b/examples/tinkerboard_mpu6050.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_pca9533.go b/examples/tinkerboard_pca9533.go index fe084c7b4..a48630ba8 100644 --- a/examples/tinkerboard_pca9533.go +++ b/examples/tinkerboard_pca9533.go @@ -12,7 +12,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_pcf8583_clock.go b/examples/tinkerboard_pcf8583_clock.go index 6392a088c..24ee1c6c7 100644 --- a/examples/tinkerboard_pcf8583_clock.go +++ b/examples/tinkerboard_pcf8583_clock.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_pcf8583_counter.go b/examples/tinkerboard_pcf8583_counter.go index 89e292792..a7f8a7378 100644 --- a/examples/tinkerboard_pcf8583_counter.go +++ b/examples/tinkerboard_pcf8583_counter.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_pcf8591.go b/examples/tinkerboard_pcf8591.go index b422ee87a..e3b132d7d 100644 --- a/examples/tinkerboard_pcf8591.go +++ b/examples/tinkerboard_pcf8591.go @@ -14,7 +14,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/aio" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) func main() { diff --git a/examples/tinkerboard_servo.go b/examples/tinkerboard_servo.go index 3c26b52b7..1ea3e9987 100644 --- a/examples/tinkerboard_servo.go +++ b/examples/tinkerboard_servo.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" "gobot.io/x/gobot/v2/platforms/adaptors" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring diff --git a/examples/tinkerboard_thermalzone.go b/examples/tinkerboard_thermalzone.go index 758ea3f65..453a38aee 100644 --- a/examples/tinkerboard_thermalzone.go +++ b/examples/tinkerboard_thermalzone.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/aio" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) // Wiring: no wiring needed diff --git a/examples/tinkerboard_yl40.go b/examples/tinkerboard_yl40.go index 7d2201443..ea6504ed0 100644 --- a/examples/tinkerboard_yl40.go +++ b/examples/tinkerboard_yl40.go @@ -13,7 +13,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/i2c" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" ) func main() { diff --git a/platforms/rockpi/LICENSE b/platforms/asus/tinkerboard/LICENSE similarity index 100% rename from platforms/rockpi/LICENSE rename to platforms/asus/tinkerboard/LICENSE diff --git a/platforms/tinkerboard/README.md b/platforms/asus/tinkerboard/README.md similarity index 100% rename from platforms/tinkerboard/README.md rename to platforms/asus/tinkerboard/README.md diff --git a/platforms/tinkerboard/adaptor.go b/platforms/asus/tinkerboard/adaptor.go similarity index 100% rename from platforms/tinkerboard/adaptor.go rename to platforms/asus/tinkerboard/adaptor.go diff --git a/platforms/tinkerboard/adaptor_test.go b/platforms/asus/tinkerboard/adaptor_test.go similarity index 100% rename from platforms/tinkerboard/adaptor_test.go rename to platforms/asus/tinkerboard/adaptor_test.go diff --git a/platforms/asus/tinkerboard/doc.go b/platforms/asus/tinkerboard/doc.go new file mode 100644 index 000000000..962e98c33 --- /dev/null +++ b/platforms/asus/tinkerboard/doc.go @@ -0,0 +1,7 @@ +/* +Package tinkerboard contains the Gobot adaptor for the ASUS Tinker Board. + +For further information refer to tinkerboard README: +https://github.com/hybridgroup/gobot/blob/release/platforms/asus/tinkerboard/README.md +*/ +package tinkerboard // import "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" diff --git a/platforms/tinkerboard/pin_map.go b/platforms/asus/tinkerboard/pinmap.go similarity index 100% rename from platforms/tinkerboard/pin_map.go rename to platforms/asus/tinkerboard/pinmap.go diff --git a/platforms/tinkerboard/tinkerboard2/README.md b/platforms/asus/tinkerboard2/README.md similarity index 100% rename from platforms/tinkerboard/tinkerboard2/README.md rename to platforms/asus/tinkerboard2/README.md diff --git a/platforms/tinkerboard/tinkerboard2/adaptor.go b/platforms/asus/tinkerboard2/adaptor.go similarity index 98% rename from platforms/tinkerboard/tinkerboard2/adaptor.go rename to platforms/asus/tinkerboard2/adaptor.go index ff7890fac..4128202a6 100644 --- a/platforms/tinkerboard/tinkerboard2/adaptor.go +++ b/platforms/asus/tinkerboard2/adaptor.go @@ -5,7 +5,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/platforms/adaptors" - "gobot.io/x/gobot/v2/platforms/tinkerboard" + "gobot.io/x/gobot/v2/platforms/asus/tinkerboard" "gobot.io/x/gobot/v2/system" ) diff --git a/platforms/tinkerboard/tinkerboard2/adaptor_test.go b/platforms/asus/tinkerboard2/adaptor_test.go similarity index 100% rename from platforms/tinkerboard/tinkerboard2/adaptor_test.go rename to platforms/asus/tinkerboard2/adaptor_test.go diff --git a/platforms/tinkerboard/tinkerboard2/pin_map.go b/platforms/asus/tinkerboard2/pinmap.go similarity index 100% rename from platforms/tinkerboard/tinkerboard2/pin_map.go rename to platforms/asus/tinkerboard2/pinmap.go diff --git a/platforms/beagleboard/beaglebone/beaglebone_adaptor.go b/platforms/beagleboard/beaglebone/adaptor.go similarity index 100% rename from platforms/beagleboard/beaglebone/beaglebone_adaptor.go rename to platforms/beagleboard/beaglebone/adaptor.go diff --git a/platforms/beagleboard/beaglebone/beaglebone_adaptor_test.go b/platforms/beagleboard/beaglebone/adaptor_test.go similarity index 100% rename from platforms/beagleboard/beaglebone/beaglebone_adaptor_test.go rename to platforms/beagleboard/beaglebone/adaptor_test.go diff --git a/platforms/beagleboard/beaglebone/black_pins.go b/platforms/beagleboard/beaglebone/pinmap.go similarity index 100% rename from platforms/beagleboard/beaglebone/black_pins.go rename to platforms/beagleboard/beaglebone/pinmap.go diff --git a/platforms/beagleboard/pocketbeagle/pocketbeagle_adaptor.go b/platforms/beagleboard/pocketbeagle/adaptor.go similarity index 100% rename from platforms/beagleboard/pocketbeagle/pocketbeagle_adaptor.go rename to platforms/beagleboard/pocketbeagle/adaptor.go diff --git a/platforms/beagleboard/pocketbeagle/pocketbeagle_adaptor_test.go b/platforms/beagleboard/pocketbeagle/adaptor_test.go similarity index 100% rename from platforms/beagleboard/pocketbeagle/pocketbeagle_adaptor_test.go rename to platforms/beagleboard/pocketbeagle/adaptor_test.go diff --git a/platforms/beagleboard/pocketbeagle/pocketbeagle_pins.go b/platforms/beagleboard/pocketbeagle/pinmap.go similarity index 100% rename from platforms/beagleboard/pocketbeagle/pocketbeagle_pins.go rename to platforms/beagleboard/pocketbeagle/pinmap.go diff --git a/platforms/friendlyelec/nanopct6/pin_map.go b/platforms/friendlyelec/nanopct6/pinmap.go similarity index 100% rename from platforms/friendlyelec/nanopct6/pin_map.go rename to platforms/friendlyelec/nanopct6/pinmap.go diff --git a/platforms/friendlyelec/nanopi/nanopi_adaptor.go b/platforms/friendlyelec/nanopi/adaptor.go similarity index 100% rename from platforms/friendlyelec/nanopi/nanopi_adaptor.go rename to platforms/friendlyelec/nanopi/adaptor.go diff --git a/platforms/friendlyelec/nanopi/nanopi_adaptor_test.go b/platforms/friendlyelec/nanopi/adaptor_test.go similarity index 100% rename from platforms/friendlyelec/nanopi/nanopi_adaptor_test.go rename to platforms/friendlyelec/nanopi/adaptor_test.go diff --git a/platforms/friendlyelec/nanopi/nanopineo_pin_map.go b/platforms/friendlyelec/nanopi/neo_pinmap.go similarity index 100% rename from platforms/friendlyelec/nanopi/nanopineo_pin_map.go rename to platforms/friendlyelec/nanopi/neo_pinmap.go diff --git a/platforms/jetson/jetson_adaptor.go b/platforms/jetson/adaptor.go similarity index 100% rename from platforms/jetson/jetson_adaptor.go rename to platforms/jetson/adaptor.go diff --git a/platforms/jetson/jetson_adaptor_test.go b/platforms/jetson/adaptor_test.go similarity index 100% rename from platforms/jetson/jetson_adaptor_test.go rename to platforms/jetson/adaptor_test.go diff --git a/platforms/jetson/jetson_pin_map.go b/platforms/jetson/pinmap.go similarity index 100% rename from platforms/jetson/jetson_pin_map.go rename to platforms/jetson/pinmap.go diff --git a/platforms/pine64/rock64/pin_map.go b/platforms/pine64/rock64/pinmap.go similarity index 100% rename from platforms/pine64/rock64/pin_map.go rename to platforms/pine64/rock64/pinmap.go diff --git a/platforms/tinkerboard/LICENSE b/platforms/radxa/rockpi/LICENSE similarity index 100% rename from platforms/tinkerboard/LICENSE rename to platforms/radxa/rockpi/LICENSE diff --git a/platforms/rockpi/README.md b/platforms/radxa/rockpi/README.md similarity index 98% rename from platforms/rockpi/README.md rename to platforms/radxa/rockpi/README.md index ba6fc76d4..7cc73e578 100644 --- a/platforms/rockpi/README.md +++ b/platforms/radxa/rockpi/README.md @@ -33,7 +33,7 @@ import ( "gobot.io/x/gobot/v2" "gobot.io/x/gobot/v2/drivers/gpio" - "gobot.io/x/gobot/v2/platforms/rockpi" + "gobot.io/x/gobot/v2/platforms/radxa/rockpi" ) func main() { diff --git a/platforms/rockpi/rockpi_adaptor.go b/platforms/radxa/rockpi/adaptor.go similarity index 100% rename from platforms/rockpi/rockpi_adaptor.go rename to platforms/radxa/rockpi/adaptor.go diff --git a/platforms/rockpi/rockpi_adaptor_test.go b/platforms/radxa/rockpi/adaptor_test.go similarity index 100% rename from platforms/rockpi/rockpi_adaptor_test.go rename to platforms/radxa/rockpi/adaptor_test.go diff --git a/platforms/radxa/rockpi/doc.go b/platforms/radxa/rockpi/doc.go new file mode 100644 index 000000000..c2b118814 --- /dev/null +++ b/platforms/radxa/rockpi/doc.go @@ -0,0 +1,7 @@ +/* +Package rockpi contains the Gobot adaptor for Radxa's Rock Pi Single Board Computers. + +For further information refer to rockpi README: +https://github.com/hybridgroup/gobot/blob/release/platforms/radxa/rockpi/README.md +*/ +package rockpi // import "gobot.io/x/gobot/v2/platforms/radxa/rockpi" diff --git a/platforms/rockpi/rockpi_pin_map.go b/platforms/radxa/rockpi/pinmap.go similarity index 100% rename from platforms/rockpi/rockpi_pin_map.go rename to platforms/radxa/rockpi/pinmap.go diff --git a/platforms/raspi/raspi_adaptor.go b/platforms/raspi/adaptor.go similarity index 100% rename from platforms/raspi/raspi_adaptor.go rename to platforms/raspi/adaptor.go diff --git a/platforms/raspi/raspi_adaptor_test.go b/platforms/raspi/adaptor_test.go similarity index 100% rename from platforms/raspi/raspi_adaptor_test.go rename to platforms/raspi/adaptor_test.go diff --git a/platforms/raspi/raspi_pin_map.go b/platforms/raspi/pinmap.go similarity index 100% rename from platforms/raspi/raspi_pin_map.go rename to platforms/raspi/pinmap.go diff --git a/platforms/rockpi/doc.go b/platforms/rockpi/doc.go deleted file mode 100644 index b2c26ce5e..000000000 --- a/platforms/rockpi/doc.go +++ /dev/null @@ -1,7 +0,0 @@ -/* -Package rockpi contains the Gobot adaptor for Radxa's Rock Pi Single Board Computers. - -For further information refer to rockpi README: -https://github.com/hybridgroup/gobot/blob/release/platforms/rockpi/README.md -*/ -package rockpi // import "gobot.io/x/gobot/v2/platforms/rockpi" diff --git a/platforms/tinkerboard/doc.go b/platforms/tinkerboard/doc.go deleted file mode 100644 index b2db191a0..000000000 --- a/platforms/tinkerboard/doc.go +++ /dev/null @@ -1,7 +0,0 @@ -/* -Package tinkerboard contains the Gobot adaptor for the ASUS Tinker Board. - -For further information refer to tinkerboard README: -https://github.com/hybridgroup/gobot/blob/release/platforms/tinkerboard/README.md -*/ -package tinkerboard // import "gobot.io/x/gobot/v2/platforms/tinkerboard" diff --git a/platforms/upboard/up2/pin_map.go b/platforms/upboard/up2/pinmap.go similarity index 100% rename from platforms/upboard/up2/pin_map.go rename to platforms/upboard/up2/pinmap.go diff --git a/system/GPIO.md b/system/GPIO.md index acf0a3273..6cc5e9e60 100644 --- a/system/GPIO.md +++ b/system/GPIO.md @@ -88,7 +88,7 @@ gpiochip0 - 54 lines: For Tinkerboard and in general for all other boards: * the name on system level differ from the header name (normally pin1..pin40) -* the mapping is done in gobot by a file named something like [pin_map.go](../platforms/tinkerboard/pin_map.go) +* the mapping is done in gobot by a file named something like [pin_map.go](../platforms/asus/tinkerboard/pin_map.go) * for the next tests the system level name is needed Connect an oscilloscope or at least a meter to the pin (used header pin26 for example). For the output tests a LED with