added pre-built Armbian image

Author: moonbuggy

GPIO-cable.sch

@@ -67,14 +67,14 @@ GPS_Tx
 Text Label 5850 3100 0    50   ~ 0
 GPS_Rx
 Wire Notes Line
-	3950 5000 7900 5000
+	3950 5050 7900 5050
 Wire Notes Line
-	7900 5000 7900 2700
+	7900 5050 7900 2700
 Wire Notes Line
 	7900 2700 3950 2700
 Wire Notes Line
-	3950 2700 3950 5000
-Text Notes 6200 4900 0    50   ~ 0
+	3950 2700 3950 5050
+Text Notes 5350 5000 0    79   ~ 0
 Orange Pi Zero <-> GPS and TFT cable
 Wire Wire Line
 	4200 4100 4600 4100

Power-Splitter.sch

@@ -3,7 +3,7 @@ EELAYER 30 0
 EELAYER END
 $Descr A4 11693 8268
 encoding utf-8
-Sheet 5 4
+Sheet 4 4
 Title ""
 Date ""
 Rev ""
@@ -29,7 +29,7 @@ L Connector_Generic:Conn_01x03 J10
 U 1 1 65C488D1
 P 5300 3600
 F 0 "J10" V 5264 3412 50  0000 R CNN
-F 1 "Power Switch" V 5173 3412 50  0000 R CNN
+F 1 "Power Control" V 5173 3412 50  0000 R CNN
 F 2 "Connectors_JST:JST_XH_B03B-XH-A_03x2.50mm_Straight" H 5300 3600 50  0001 C CNN
 F 3 "~" H 5300 3600 50  0001 C CNN
 	1    5300 3600
@@ -49,22 +49,22 @@ $EndComp
 $Comp
 L Connector_Generic:Conn_01x02 J12
 U 1 1 65C48BD5
-P 6850 3600
-F 0 "J12" V 6814 3412 50  0000 R CNN
-F 1 "Bias Tee" V 6723 3412 50  0000 R CNN
-F 2 "Connectors_JST:JST_XH_B02B-XH-A_02x2.50mm_Straight" H 6850 3600 50  0001 C CNN
-F 3 "~" H 6850 3600 50  0001 C CNN
-	1    6850 3600
+P 6750 3600
+F 0 "J12" V 6714 3412 50  0000 R CNN
+F 1 "Bias Tee" V 6623 3412 50  0000 R CNN
+F 2 "Connectors_JST:JST_XH_B02B-XH-A_02x2.50mm_Straight" H 6750 3600 50  0001 C CNN
+F 3 "~" H 6750 3600 50  0001 C CNN
+	1    6750 3600
 	0    -1   -1   0   
 $EndComp
 Wire Wire Line
 	5200 3900 5200 3800
 Wire Wire Line
 	5300 4050 5300 3800
 Wire Wire Line
-	6950 3800 6950 4050
+	6850 3800 6850 4050
 Wire Wire Line
-	6950 4050 6300 4050
+	6850 4050 6300 4050
 Wire Wire Line
 	6300 3800 6300 4050
 Connection ~ 6300 4050
@@ -75,12 +75,12 @@ Wire Wire Line
 Wire Wire Line
 	5400 3900 6200 3900
 Wire Wire Line
-	6850 3900 6850 3800
+	6750 3900 6750 3800
 Wire Wire Line
 	6200 3800 6200 3900
 Connection ~ 6200 3900
 Wire Wire Line
-	6200 3900 6850 3900
+	6200 3900 6750 3900
 Text Label 4850 3900 0    50   ~ 0
 GND
 Wire Wire Line
@@ -100,8 +100,8 @@ $Comp
 L Jumper:Jumper_2_Open JP1
 U 1 1 65C4DC8A
 P 5000 4250
-F 0 "JP1" H 5000 4100 50  0000 C CNN
-F 1 "Jumper_2_Open" H 5000 4000 50  0000 C CNN
+F 0 "JP1" H 5000 4150 50  0000 C CNN
+F 1 "Bypass Jumper" H 5000 4050 50  0000 C CNN
 F 2 "Pin_Headers:Pin_Header_Straight_1x02_Pitch2.54mm" H 5000 4250 50  0001 C CNN
 F 3 "~" H 5000 4250 50  0001 C CNN
 	1    5000 4250
@@ -117,4 +117,14 @@ Wire Wire Line
 Wire Wire Line
 	5400 4250 5400 3900
 Connection ~ 5400 3900
+Wire Notes Line
+	4500 3450 7350 3450
+Wire Notes Line
+	7350 3450 7350 4550
+Wire Notes Line
+	4500 4550 4500 3450
+Text Notes 6400 4450 0    79   ~ 0
+Power Splitter
+Wire Notes Line
+	7350 4550 4500 4550
 $EndSCHEMATC

README.md

@@ -21,13 +21,15 @@ display and the other devices.
     +   [Wiring](#wiring)
         -   [Schematic](#schematic)
         -   [Cable](#cable)
+        -   [Power Splitter](#power-splitter)
 *   [Software](#software)
-    +   [Armbian](#armbian)
-        -   [Custom Devive Tree Overlays](#custom-devive-tree-overlays)
-    +   [Status LED](#status-led)
-    +   [gpsd](#gpsd)
-    +   [chrony](#chrony)
-    +   [fbgpsclock](#fbgpsclock)
+    +   [Pre-built OS Image](#pre-built-os-image)
+    +   [Manual Configuration](#manual-configuration)
+        -   [Armbian](#armbian)
+        -   [Status LED](#status-led)
+        -   [gpsd](#gpsd)
+        -   [chrony](#chrony)
+        -   [fbgpsclock](#fbgpsclock)
 *   [Links](#links)
 
 ## Hardware
@@ -57,8 +59,8 @@ display and the other devices.
 </a><br/>
 <em>side</em></p>
 
-There's also [gallery __(NSFW)__](https://imgur.com/a/yd1e8r0) with some images
-from various stages of testing and building.
+There's also [a gallery __(NSFW)__](https://imgur.com/a/yd1e8r0) with some
+images from various stages of testing and building.
 
 ### Components
 #### Orange Pi Zero
@@ -163,9 +165,9 @@ More details are available at [moonbuggy/GPIO-power-switch][moonbuggy/GPIO-power
 <em>GPIO wiring</em></p>
 
 #### Cable
-The specific pins chosen allow us to make a convenient cable to connect the GPS
-and TFT modules while leaving the I2C pins clear for the RTC module to plug
-directly in.
+The specific pins chosen allow us to make a convenient cable to connect the GPS,
+TFT and power control modules while leaving the I2C pins clear for the RTC
+module to plug directly in.
 
 <p><a href="images/schematic-cable-2.0inch.png">
   <img src="images/schematic-cable-2.0inch.png" width="600">
@@ -191,8 +193,55 @@ The OPiZ end of the cable will attach to GPIO pins 11 to 26. Using a
 black wire for the ground connection to OPiZ pin 25 provides a convenient way to
 align the connector, regardless of the other wire colours.
 
+#### Power Splitter
+<p><a href="images/schematic-splitter.png">
+  <img src="images/schematic-splitter.png" width="600">
+</a><br/>
+<em>power splitter</em></p>
+
+In an ideal world there'd be enough room in the enclosure to combine this
+splitter and the power control circuit on a single PCB, to save a cable run
+(although it's not a big deal that they're separate).
+
+Closing the jumper bypasses the switch in the power control circuit, directly
+connecting the OPiZ and bias tee to ground, and is useful during testing. The
+button and LED in the power control circuit will still work as expected, and
+the MOSFET will still switch, it just won't have any effect and actually cut
+power after a <code>shutdown -h</code> command or button press.
+
 ## Software
-### Armbian
+### Pre-built OS Image
+There's a pre-built Armbian image at
+[moonbuggy/sbc-os-images](https://github.com/moonbuggy/sbc-os-images/releases/tag/Armbian-23.11.0-OPiZ-GPS-NTP)
+which will work out of the box for a build using the same (or compatible)
+hardware wired as described above. All the setup and configuration steps below
+have been done during the image creation.
+
+Simply write the _*.img.xz_ file to an SD card, put the card in the OPiZ, power
+it up.
+
+GPS devices other than the Neo M8N should work easily with this image, so long
+as they use _uart2_ (and use _pin 15_/_PA03_ for the PPS signal). A different
+display controller or RTC, however, would be incompatible with the device tree
+in the image.
+
+It's possible to re-configure the pre-built OS after first boot, if necessary
+to adjust for differing hardware. Depending on how much modification is needed,
+it may be easier to start with a bare OS and do the manual steps described
+below.
+
+#### Packages
+The _*.deb_ files in the release are packages which can be installed on top of
+an existing Armbian install, as an alternative to the pre-built image.
+
+These packages just add the modules necessary for the GPIO power switch to work
+to the kernel. They do not install any GPS/NTP/TFT software or handle any of the
+configuration like the image does.
+
+Install with: <code>sudo dpkg -i *.deb</code>
+
+### Manual Configuration
+#### Armbian
 We need to enable the _i2c0_, _pps-gpio_, _tve_ and _uart2_ devices. It probably
 makes sense to enable _clock-1.2GHz-1.3v_ as well, if it isn't by default. This
 can be done in `armbian-config` or by editing _/boot/armbianEnv.txt_.
@@ -203,7 +252,7 @@ regardless of how the hardware overlays above are enabled:
 sudo sh -c "echo 'param_pps_pin=PA3' >> /boot/armbianEnv.txt"
 ```
 
-#### Custom Devive Tree Overlays
+##### Custom Devive Tree Overlays
 The device tree source (DTS) files in this repo for the display are for an
 ST7789V SPI TFT controller with a 240x280 or 240x320 display. They can be
 modified for other resolutions.
@@ -226,7 +275,7 @@ sudo armbian-add-overlay gpio-key-power.dts
 sudo armbian-add-overlay sun8i-h3-gpio-poweroff.dts
 ```
 
-##### Display Driver Init
+###### Display Driver Init
 Both DTS files contain a custom init for the driver. This init sequence is based
 off that in the kernel driver (as opposed to that in the ST7789V datasheet,
 which differs in some places), with only the _VSCSAD (37h): Vertical Scroll
@@ -250,27 +299,27 @@ The _240x320_ DTS is just using the kernel driver's default init unmodified. The
 `init` section probably doesn't need to be in this DTS, but it's a convenient
 reference for the defaults.
 
-### Status LED
+#### Status LED
 If using the [moonbuggy/GPIO-power-switch][moonbuggy/GPIO-power-switch] module,
 the status LED can be changed from red to green to indicate the device is ready
 by pulling pin 16 (_PA19_) low. In this case we'll indicate 'ready' with a
 systemd service, once both the _gpsd_ and _chrony_ services are running.
 
-##### /usr/lib/systemd/system/ready.target
+###### /usr/lib/systemd/system/ready.target
 ```ini
 [Unit]
 Description=System is booted and ready (for toggling status LED)
-Requires=chrony.service gpsd.service gpsd.socket multi-user.target
-After=chrony.service gpsd.service gpsd.socket multi-user.target
+Requires=fbgpsclock.service chrony.service gpsd.service gpsd.socket multi-user.target
+After=fbgpsclock.service chrony.service gpsd.service gpsd.socket multi-user.target
 AllowIsolate=yes
 ```
 
-##### /usr/lib/systemd/system/ready-led.service
+###### /usr/lib/systemd/system/ready-led.service
 ```ini
 [Unit]
 Description='ready' status indicator LED
-After=chrony.service gpsd.service gpsd.socket
-Requires=chrony.service gpsd.service gpsd.socket
+After=fbgpsclock.service chrony.service gpsd.service gpsd.socket
+Requires=fbgpsclock.service chrony.service gpsd.service gpsd.socket
 
 [Service]
 Type=oneshot
@@ -289,18 +338,18 @@ sudo systemctl enable ready-led
 sudo systemctl set-default ready.target
 ```
 
-### gpsd
-#### Installation
+#### gpsd
+##### Installation
 ```sh
 sudo apt install gpsd
 
 # optional tools
 sudo apt install gpsd-tools pps-tools
 ```
 
-##### /etc/default/gpsd
+###### /etc/default/gpsd
 ```ini
-# Devices gpsd should collect to at boot time.
+# Devices gpsd should connect to at boot time.
 # They need to be read/writeable, either by user gpsd or the group dialout.
 DEVICES="/dev/ttyS2 /dev/pps0"
 
@@ -326,13 +375,13 @@ sudo systemctl enable gpsd
 sudo systemctl start gpsd
 ```
 
-### chrony
-#### Installation
+#### chrony
+##### Installation
 ```sh
 sudo apt install chrony
 ```
 
-##### /etc/chrony/conf.d/gpsd.conf
+###### /etc/chrony/conf.d/gpsd.conf
 ```ini
 refclock SHM 0 refid NMEA offset 0.110
 refclock PPS /dev/pps0 refid PPS lock NMEA
@@ -347,7 +396,7 @@ The default configuration for the RTC is for chrony to tell the system to set it
 every 11 minutes. To let chrony set the time from the RTC (as a backup if
 there's some issue with the GPS), it needs to be run with the `-s` argument.
 
-##### /etc/default/chrony
+###### /etc/default/chrony
 ```sh
 # This is a configuration file for /etc/init.d/chrony and
 # /lib/systemd/system/chrony.service; it allows you to pass various options to
@@ -357,7 +406,7 @@ there's some issue with the GPS), it needs to be run with the `-s` argument.
 DAEMON_OPTS="-F 1 -r -m -s"
 ```
 
-### fbgpsclock
+#### fbgpsclock
 The [fbgpsclock][moonbuggy/fbgpsclock] repo contains software for displaying
 time and GPS information on the TFT display.
 
@@ -366,7 +415,7 @@ time and GPS information on the TFT display.
 </a><br/>
 <em>fbgpsclock screenshot</em></p>
 
-#### Installation
+##### Installation
 Check build dependencies are installed (this may not be a complete dependency
 list):
 ```sh
@@ -388,6 +437,7 @@ More detail and configuration information is available at [moonbuggy/fbgpsclock]
 ## Links
 ### Software
 *   [moonbuggy/fbgpsclock][moonbuggy/fbgpsclock]
+*   [moonbuggy/sbc-os-images][moonbuggy/sbc-os-images]
 
 ### Hardware
 *   [moonbuggy/GPIO-power-switch][moonbuggy/GPIO-power-switch]
@@ -398,4 +448,5 @@ More detail and configuration information is available at [moonbuggy/fbgpsclock]
 *   [ST7789V](https://newhavendisplay.com/content/datasheets/ST7789V.pdf)
 
 [moonbuggy/fbgpsclock]: https://github.com/moonbuggy/fbgpsclock
+[moonbuggy/sbc-os-images]: https://github.com/moonbuggy/sbc-os-images
 [moonbuggy/GPIO-power-switch]: https://github.com/moonbuggy/GPIO-power-switch

images/enclosed-rear.jpg

@@ -1,17 +1,16 @@
 /dts-v1/;
 /plugin/;
 
-/* This overlay will pull a pin high to signal the OS has shutdown and
-   it's safe to cut power to the board (and the rest of the enclosure).
+/* This overlay will pull a pin high to signal the OS has shutdown and it's safe
+   to cut power to the board (and the rest of the enclosure).
 
-   Pulling high on shutdown is better than pulling low because once
-   power has been cut the high signal will fall back to low. This means
-   an SR latch won't have behave in an undefined manner when a "power
-   on" button is pressed to restore power to the enclosure, as the
-   "power off" signal will clear itself.
+   Pulling high on shutdown is better than pulling low because once power has
+   been cut the high signal will fall back to low. This means an SR latch won't
+   behave in an undefined manner when a "power on" button is pressed to restore
+   power to the enclosure, as the "power off" signal will clear itself.
 
-   CONFIG_POWER_RESET_GPIO and CONFIG_POWER_RESET_GPIO_RESTART need to
-   be enabled in the kernel for this to work.
+   CONFIG_POWER_RESET_GPIO and CONFIG_POWER_RESET_GPIO_RESTART need to be
+   enabled in the kernel for this to work.
 
    See: https://www.kernel.org/doc/Documentation/devicetree/bindings/power/reset/gpio-poweroff.txt
 */

images/schematic-splitter.png

@@ -1,4 +1,4 @@
-# Devices gpsd should collect to at boot time.
+# Devices gpsd should connect to at boot time.
 # They need to be read/writeable, either by user gpsd or the group dialout.
 DEVICES="/dev/ttyS2 /dev/pps0"
 

overlays/sun8i-h3-gpio-poweroff.dts

@@ -1,7 +1,7 @@
 [Unit]
 Description='ready' status indicator LED
-After=chrony.service gpsd.service gpsd.socket
-Requires=chrony.service gpsd.service gpsd.socket
+After=fbgpsclock.service chrony.service gpsd.service gpsd.socket
+Requires=fbgpsclock.service chrony.service gpsd.service gpsd.socket
 
 [Service]
 Type=oneshot

root/etc/default/gpsd

@@ -1,5 +1,5 @@
 [Unit]
 Description=System is booted and ready (for toggling status LED)
-Requires=chrony.service gpsd.service gpsd.socket multi-user.target
-After=chrony.service gpsd.service gpsd.socket multi-user.target
+Requires=fbgpsclock.service chrony.service gpsd.service gpsd.socket multi-user.target
+After=fbgpsclock.service chrony.service gpsd.service gpsd.socket multi-user.target
 AllowIsolate=yes