Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arkits/onhub-web

The missing Web UI for Google OnHub and Google Wifi Devices
https://github.com/arkits/onhub-web

golang google-wifi onhub

Last synced: about 2 months ago
JSON representation

The missing Web UI for Google OnHub and Google Wifi Devices

Host: GitHub
URL: https://github.com/arkits/onhub-web
Owner: arkits
License: mit
Created: 2021-01-20T05:16:24.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2021-02-10T03:13:26.000Z (almost 4 years ago)
Last Synced: 2024-03-31T18:41:14.776Z (9 months ago)
Topics: golang, google-wifi, onhub
Language: Go
Homepage:
Size: 1.69 MB
Stars: 11
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# onhub-web

## About

onhub-web (ohw) is the missing web client for interacting with and monitoring Google OnHub and Google Wifi devices.

onhub-web talks to the [Google Foyer APIs](https://documenter.getpostman.com/view/7490211/SzzdD1pF?version=latest) to retrieve metrics regarding your Google OnHub / Google Home devices. These metrics are then accessible through various avenues including a web UI and Prometheus / Grafana dashboard.

![onhub-web's web UI](./docs/img/ohw-web-ui.png)

## Getting Started

### Config file

To get started, create a `config.yaml` based on [sample config](./config.sample.yaml).

### Running Locally

```bash
# Download the Node.js dependencies
~/Dev/onhub-web/web ❯ yarn

# Build the frontend client
~/Dev/onhub-web/web ❯ yarn build

# Download Go dependencies
~/Dev/onhub-web ❯ go mod download

# Run the server
~/Dev/onhub-web ❯ go run main.go
```

### Building

```bash
# Build a stand-alone binary (includes web UI)
~/Dev/onhub-web/scripts ❯ ./make.sh

# Build a stand-alone binary (includes web UI) for Raspberry Pi 4
~/Dev/onhub-web/scripts ❯ ./make_pi.sh
```

### Grafana

onhub-web also exposes the metrics through a Prometheus metrics endpoint and a compatible Grafana dashboard is also available.

![onhub-web's Grafana Dashboard](./docs/img/ohw-grafana-dashboard.png)