https://github.com/Bunn/pi_monitor

Python utility to get Raspberry Pi metrics
https://github.com/Bunn/pi_monitor

Last synced: 3 months ago
JSON representation

Python utility to get Raspberry Pi metrics

• Host: GitHub
• URL: https://github.com/Bunn/pi_monitor
• Owner: Bunn
• License: bsd-2-clause
• Created: 2020-07-24T09:59:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-17T17:42:17.000Z (about 4 years ago)
• Last Synced: 2024-04-20T17:00:45.975Z (7 months ago)
• Language: Python
• Size: 20.5 KB
• Stars: 37
• Watchers: 9
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pi Monitor

Python utility to get Raspberry Pi metrics. This is an experimental utility, use at your own risk :)

This is just a very simple Python script using a http server to provide some Raspberry Pi metrics via REST calls, like temperature, load average and more.

## Usage

The server will make a single endpoint available on the default port `8088`:

`http://YOUR_IP:8088/monitor.json` that will return a JSON like this:

```json

{

  "soc_temperature": 50.5,

  "uptime": 18551.34,

  "load_average": [0.0, 0.2, 0.1],

  "kernel_release": "5.4.51-v7+",

  "memory": {

    "total_memory": 441416,

    "free_memory": 90536,

    "available_memory": 279512

  }

}

```

## Installation

### Automatic

`wget -O - https://raw.githubusercontent.com/Bunn/pi_monitor/master/install.sh | sudo bash`

### Manual

You can download the files manually and run it the way you like. If you don't want Pi Monitor to run as a service you can just run as `python3 pi_monitor.py`

## Configuration

If you're running it using the automatic installation you can change the username and default port in which Pi Monitor is running by changing the following settings on your `pi-monitor.service`

```

[Service]

ExecStart=/usr/bin/python3 -u /usr/local/bin/pi-monitor.py 8088

User=pi

```

Before doing so, make sure to stop the service with

`sudo systemctl stop pi-monitor.service`

and then start it again after your changes with

`sudo systemctl start pi-monitor.service`

If you're running it manually you can just change the default port by sending it as a parameter like:

`python3 pi_monitor.py 8181`

## Compatibility

This was tested on Raspberry Pi OS (32 bit), kernel 5.4.51-v7+