# HypeRate IRL Widget Configurator

> Free browser-based configurator for IRL streamers to build, customize, and export real-time overlay widgets — covering heart rate, GPS, speed, distance, elevation, and live weather — ready to paste into OBS as a Browser Source.

## Features

- **Single Widget** — display one data source (heart rate, GPS location, speed, distance, G-force, elevation, temperature, precipitation probability, or wind speed) as a standalone OBS overlay.
- **Summary Views** — combine all activity widgets (Time, Calories, Speed, Distance, G-Force, Location) or all weather widgets (Temperature, Precipitation, Wind, Elevation) into one multi-data overlay.
- **Auto-Switching** — rotate between data endpoints automatically at a configurable interval (1–60 seconds), generating a single rotating browser-source URL.
- **Full Customization** — adjust font family, font size, font color, background color (with opacity via 8-digit hex), icon style (animated / static), icon sub-style (filled / outlined), gap, border radius, and layout direction (normal / reversed).
- **Metric & Imperial** — all speed, distance, elevation, and temperature widgets support both unit systems.
- **Live Preview** — connect a real HypeRate Device ID to see the widget with live telemetry before exporting.
- **OBS Integration** — one-click URL copy; add it as a Browser Source in OBS Studio or any compatible streaming app.
- **Privacy-aware location display** — choose City & Country, Country Only, or Flag Only for the location widget.

## Widget Types

| Widget | Data shown | Supports unit toggle |
|---|---|---|
| Time | Elapsed session time | — |
| Burned Calories | kcal or cal | yes |
| Speed | km/h or mph | yes |
| Distance | km or mi | yes |
| G-Force | g | — |
| Location | City, Country, or Flag | — |
| Temperature | °C or °F + UV index badge | yes |
| Precipitation Probability | % | — |
| Wind Speed | km/h or mph | yes |
| Elevation | m or ft | yes |

## Documentation

- [IRL Widget Configurator](https://irl.hyperate.io/) — main configurator app
- [Help & FAQ](https://irl.hyperate.io/faq/) — step-by-step setup guide and common questions
- [HypeRate Blog](https://blog.hyperate.io/) — announcements, guides, and streamer tips
- [Blog Feed (RSS)](https://blog.hyperate.io/feed.xml)
- [Sitemap](https://irl.hyperate.io/sitemap.xml)
- [RSS Feed](https://irl.hyperate.io/feed.xml)
- [Atom Feed](https://irl.hyperate.io/atom.xml)

## API

The configurator consumes the [HypeRate WebSocket API](https://github.com/alexholzreiter/HypeRate-Websocket-API) to stream real-time telemetry from a paired HypeRate device:

- Heart rate, burned calories, elapsed time
- Speed, distance, G-force
- GPS location (city, country, country code)
- Altitude / elevation
- Weather: temperature, precipitation probability, wind speed, UV index, weather symbol

Widget URLs follow the pattern:

```
https://irl.hyperate.io/irl/raw/{endpoint}/{hyperate-id}?{params}
```

Summary view URLs:

```
https://irl.hyperate.io/irl/activity/{hyperate-id}?{params}
https://irl.hyperate.io/irl/weather/{hyperate-id}?{params}
```

Rotating (auto-switch) URL:

```
https://irl.hyperate.io/irl/rotate/?summaryType={activities|weather}&username={hyperate-id}&{params}
```

## AI Endpoints

- [AI Summary](https://irl.hyperate.io/ai/summary.json)
- [AI FAQ](https://irl.hyperate.io/ai/faq.json)
- [AI Service Description](https://irl.hyperate.io/ai/service.json)

## About

HypeRate is a platform built for IRL and outdoor content creators. The IRL Widget Configurator is a free tool — no account required to configure or preview widgets.

- [HypeRate main site](https://hyperate.io)
- [HypeRate Blog](https://blog.hyperate.io/)
- [HypeRate on LinkedIn](https://www.linkedin.com/company/hyperate-io/)
- [HypeRate WebSocket API on GitHub](https://github.com/alexholzreiter/HypeRate-Websocket-API)