README.md

# Monitor & Information Rest API for Raspberry PI

Branched from @cl0udninja [project](https://github.com/cl0udninja/raspberrypi.monitor)

This is a project based on [SpringBoot](https://spring.io/projects/spring-boot) 2.0 and [Pi4J](http://pi4j.com).

Current version *1.3*

# Projects using this java app

* Hubitat [RaspberryPi Stats and DHT](https://github.com/sgrayban/Hubitat-Ports/tree/master/Drivers/rpi)

# Pre-compiled releases

There are pre-compiled releases built on the RaspberryPi 3B+ locate [here](releases/tag/v1.3)

**!NOTE!!** They may not work on other boards.

# Pre-requisites

* [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) - apt install oracle-java8-jdk
* [Maven 3x](https://maven.apache.org/download.cgi) - apt install maven

# Download
Make sure you are in /root directory first then....

```git clone https://github.com/sgrayban/raspberrypi.monitor.git```

## Editing for the [Raspberry Pi DHT11/22 Sensor](https://github.com/sgrayban/Hubitat-Ports/tree/master/Drivers/rpi#raspberry-pi-dht1122-sensor-device-handler)
1. You should **test** the python script first to make sure your settings are correct here or you will have to compile again.
2. Edit line 19 in src/main/java/com/cl0udninja/raspberrypi/monitor/service/TemperatureService.java
   - Line reads ```Process pr = rt.exec("/root/bin/AdafruitDHT.py 11 17");```
     - First number is the DHT type - it's either DHT11 or DHT22 - Example is 11
      - Second number is the [GPIO](https://pinout.xyz/#) BCM pin - Example is 17

# Build as root

Simply

```bash
cd /root/raspberrypi.monitor

mvn clean install
```

# Installation

Install raspberrypi_monitor.service as a Systemd script to start at boot

```bash
cp raspberrypi_monitor.service /etc/systemd/system/raspberrypi_monitor.service
systemctl daemon-reload
systemctl enable raspberrypi_monitor.service
systemctl start raspberrypi_monitor.service
```

Then to make sure the app is running

```bash
systemctl status raspberrypi_monitor.service
```
Should yeld something like this

```bash
# systemctl status raspberrypi_monitor.service
● raspberrypi_monitor.service - Manage raspberrypi monitor service
   Loaded: loaded (/etc/systemd/system/raspberrypi_monitor.service; enabled; vendor preset: enabled)
   Active: active (running) since Thu 2019-04-11 16:53:01 PDT; 2min 22s ago
 Main PID: 316 (java)
   CGroup: /system.slice/raspberrypi_monitor.service
           └─316 /usr/bin/java -jar /root/janipi/target/raspberrypi.janipi-0.0.1-SNAPSHOT.jar
```

# Upgrading to version 1.3

A lot of things have changed since I first posted this project and as such install must change!

First raspberrypi_monitor.service has been changed.

1) Install raspberrypi_monitor.service as a Systemd script to start at boot

```bash
cp raspberrypi_monitor.service /etc/systemd/system/raspberrypi_monitor.service
systemctl daemon-reload
systemctl start raspberrypi_monitor.service
```

# Usage for PI Stats

```
http://Rpi-IP:8080/api/pi
```

Would yield something like this:

```json
{
"osName": Linux
"cpuTemperature": 52.1,
"serialNumber": "0000000000000000",
"cpuCoreVoltage": 1.2,
"modelName": "ARMv7 Processor rev 4 (v7l)",
"boardType": "RaspberryPi_3B",
"totalMemory": 967700480,
"usedMemory": 221253632,
"freeMemory": 401907712,
"sharedMemory": 14475264,
"javaVersion": "1.8.0_152",
"hostname": "raspberrypi",
"ipAddresses": [
"192.168.1.40",
"172.17.0.1"
],
"nameservers":[
"8.8.8.8"
"192.168.0.36"
"2001:428::1"
"2001:428::2"
]
"cpuFrequency": 600000000
}
```

## Usage for the DHT sensor

```
http://Rpi-IP:8080/api/dht
```

Would yield something like this:

```json
{
"temperature":69.8,
"humidity":58.0
}
```

# RELEASES
2019-04-15 :: 1.3

* Added Support for Raspberry Pi 3A+
* Added support for Raspberry Pi 3B+
* Added support for Raspberry Pi Zero W
* Added support for Raspberry Pi Compute Module 3+
* Added support for Raspberry Pi Compute Module 3

# Supported Hardware

* Raspberry Pi - A
* Raspberry Pi - B (Revision 1)
* Raspberry Pi - B (Revision 2)
* Raspberry Pi - A+
* Raspberry Pi - B+
* Raspberry Pi - 2B
* Raspberry Pi - 3B
* Raspberry Pi - 3B+
* Raspberry Pi - 3A+
* Raspberry Pi - Zero
* Raspberry Pi - Zero W
* Raspberry Pi - CM1 (Compute Module)
* Raspberry Pi - CM3 (Compute Module)
* Raspberry Pi - CM3+ (Compute Module)