Pi4J V2 :: Tools to prepare Raspberry Pi OS for Java

This project provides some scripts to extend the official Raspberry Pi Operating System with additional tools to make it the perfect match for Java projects with Pi4J as described on the Pi4J website > Prepare a Raspberry Pi.

Hardware Configurations and Java Tools

With Raspberry Pi OS

Follow these steps to prepare your Raspberry Pi for Java development when you use the official Raspberry Pi operating system:

1. Prepare an SD Card with
   • For Raspberry Pi: The 64-bit version of the Raspberry Pi Operating System, see the Pi4J website > Prepare a Raspberry Pi > Write OS to SD card.
   • For other type of
2. Put the SD Card in your Raspberry Pi and start it.
3. The board will probably reboot to do some basic settings.
4. Make sure the board is connected to WiFi or cabled internet.
5. Open the terminal and run this command:

   curl -sL https://raw.githubusercontent.com/Pi4J/pi4j-os/main/script/prepare-for-java.sh | bash
   

6. Make sure you see All done! Have fun... if the script finished. If not, you may need to run it again as one of the intermediate steps has stopped it.
7. You're done! Check the Pi4J website > Getting Started With Pi4J for the next steps. Have fun with #JavaOnRaspberryPi.

With Other Linux Distributions and/or Boards

In case you are using Debian, Ubuntu, or another Linux operating system on a Raspberry Pi, or you are using a Linux distribution on another type of single board computer with GPIOs, you can may need one of the following scripts.

To install Java 25, JBang, and various other tools related to Java development, open the terminal and run this command:

curl -sL https://raw.githubusercontent.com/Pi4J/pi4j-os/main/script/prepare-for-java-non-rpi.sh | bash

When you get one of these messages:

• No groups for provider is present in the system
• Current user does not belong to required groups!

Open the terminal and run this command to configure the required permissions for the FFM plugin in Pi4J V4:

curl -sL https://raw.githubusercontent.com/Pi4J/pi4j-os/main/script/setup-permissions.sh | bash

Wallpaper with System Information

An additional Java (JBang) script is available to turn the desktop wallpaper into an information screen. This script will take an image as input, overlay some useful info as text (IP, Java version, etc.), and save this as a new image. This generated image is then pushed as the new wallpaper to the desktop.

To install the script, open the terminal and run this command:

curl -sL https://raw.githubusercontent.com/Pi4J/pi4j-os/main/script/install-wallpaper.sh | bash

This will generate a result like this:

Script tests:

# Simulate interface up event for eth0
sudo /etc/NetworkManager/dispatcher.d/99-ip-change-notify eth0 up

# Simulate interface up event for wlan0 (WiFi)
sudo /etc/NetworkManager/dispatcher.d/99-ip-change-notify wlan0 up

# Check the logs immediately after
sudo tail /var/log/ip-change-notify.log

IO Checks

This repository contains a tool to check the status of the Raspberry Pi's IO configurations. It can be used to check if the IO configurations are correct for your project.

For each IO type, one or more checks are performed. You will get a result like this, indicating if the check passed or failed, with more info about the expected and found result:

Results from PWM Detection
  Configuration check for PWM in config.txt
    Status: PASS
	Expected: 
	  dtoverlay=pwm (or dtoverlay=pwm-2chan for 2-channel PWM)
	Result: 
	  Found in /boot/firmware/config.txt: dtoverlay=pwm-2chan

1. Make sure JBang is installed on your Raspberry Pi.
2. You don't need to checkout the code, as JBang will download the script automatically from GitHub.
3. To execute all checks, run:

jbang https://github.com/pi4j/pi4j-os/blob/main/iochecks/IOChecker.java

4. Individual checks can be executed by passing one or more check names as argument:
   • gpio
   • pwm
   • i2c
   • spi
   • serial
5. For example:
   • Only PWM:

   jbang https://github.com/pi4j/pi4j-os/blob/main/iochecks/IOChecker.java pwm
   

   • I2C and SPI:

   jbang https://github.com/pi4j/pi4j-os/blob/main/iochecks/IOChecker.java i2c spi
   

History Of This Repository

The original goal of this repository was to provide a build of the official Raspberry Pi OS with additional tools to prepare it for Java(FX) and Pi4J projects. Because it became difficult to support because of changes in the OS for the Raspberry Pi 5, we decided to stop this goal, and provide some scripts here that can help you to achieve the same result. You can still find the latest sources of the Pi4J OS here with the tag end-of-os.

License

This repository is licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.