Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zachowj/xfinity-data-usage
Fetch Xfinity data usage and serve it via an HTTP endpoint, publish it to MQTT or post it to an URL.
https://github.com/zachowj/xfinity-data-usage
data home-assistant mqtt usage xfinity xfinity-data
Last synced: 14 days ago
JSON representation
Fetch Xfinity data usage and serve it via an HTTP endpoint, publish it to MQTT or post it to an URL.
- Host: GitHub
- URL: https://github.com/zachowj/xfinity-data-usage
- Owner: zachowj
- License: mit
- Created: 2020-08-22T05:49:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T23:53:15.000Z (29 days ago)
- Last Synced: 2024-10-10T12:35:28.999Z (26 days ago)
- Topics: data, home-assistant, mqtt, usage, xfinity, xfinity-data
- Language: TypeScript
- Homepage: https://hub.docker.com/r/zachowj/xfinity-data-usage
- Size: 806 KB
- Stars: 53
- Watchers: 6
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[![Release Version][release-shield]][release-link] [![Docker Pulls][docker-pulls]][docker-link] [![License][license-shield]](LICENSE.md)
[![BuyMeCoffee][buymecoffee-shield]][buymecoffee-link]
# Xfinity Data Usage
Fetch Xfinity data usage and serve it via an HTTP endpoint, publish it to MQTT or post it to an URL.
## Getting Started
### Configuaration
`config.yml` located in the `/config` directory
**xfinity**
Xfinity Account credentials are required.
| Option | | Description |
| ----------- | ---------- | -------------------------------------------------------------------------------- |
| username | _required_ | Username for Xfinity, can be defined as an environment variable XFINITY_USERNAME |
| password | _required_ | Password for Xfinity, can be defined as an environment variable XFINITY_PASSWORD |
| interval | | The interval at which to update usage data. Defaults to 60 minutes. |
| pageTimeout | | Number of seconds until request times out. Defaults to 30 seconds |
**http** _(optional)_
Enable HTTP endpoints for most recent data. Defaults to port 7878.
Raw data at `http://ipaddress:7878`
Home Assistant rest sensor at `http://ipaddress:7878/homeassistant`
**post** _(optional)_
Enable posting of data after an update to the provided URL.
| Option | | Description |
| ------ | ---------- | ------------------------------- |
| url | _required_ | URL where to post usage data to |
**mqtt** _(optional)_
| Option | | Description |
| -------------------- | ---------- | --------------------------------------------------------------------------------- |
| host | _required_ | Address of MQTT server |
| port | | Port of MQTT server defaults to `1883` |
| username | | Username for MQTT server, can be defined as an environment variable MQTT_USERNAME |
| password | | Password for MQTT server, can be defined as an environment variable MQTT_PASSWORD |
| topic | _required_ | Topic to publish usage data to if Home Assistant is not set |
| homeassistant | | When set will publish to auto-discovery topics |
| homeassistant.prefix | | Auto discovery prefix topic. Defaults to `homeassistant` |
Complete config
```yaml
xfinity:
username: USERNAME
password: PASSWORD
interval: 60
http:
post:
url: http://localhost:1880/xfinity
mqtt:
host: localhost
port: 1883
username: USERNAME
password: PASSWORD
topic: xfinity
homeassistant:
prefix: "homeassistant"
```
#### Environment Variables
- `XFINITY_USERNAME` - Xfinity username
- `XFINITY_PASSWORD` - Xfinity password
- `XFINITY_RECORD_VIDEO` - Record video of the browser session. Defaults to `false`
- `XFINITY_RECORD_VIDEO_DIR` - Directory to save the video. Defaults to `/config`
- `MQTT_USERNAME` - MQTT username
- `MQTT_PASSWORD` - MQTT password
#### docker-compose
```
version: '3.7'
services:
xfinity:
image: zachowj/xfinity-data-usage:latest
container_name: xfinity
restart: unless-stopped
ports:
- 7878:7878
volumes:
- config:/config
environment:
TZ: America/Los_Angeles
LOGGING_LEVEL: info
```
#### Volumes
- `/config` - Directory for the config file
## Logging
The logging level can be changed by adding the environment variable `LOGGING_LEVEL`. Default level is `info`.
Valid log levels: `error`, `warn`, `info`, `verbose`, `debug`, `silly`
## Find Us
- [GitHub](https://github.com/zachowj/xfinity-data-usage)
- [Docker](https://hub.docker.com/r/zachowj/xfinity-data-usage)
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags on this repository](https://github.com/zachowj/xfinity-data-usage/tags).
## Authors
- [zachowj](https://github.com/zachowj) - _Initial work_
See also the list of [contributors](https://github.com/zachowj/xfinity-data-usage/contributors) who
participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Related
- [Helm Chart for Xfinity Data Usage deployment on Kubernetes](https://github.com/naterator/helm-charts/tree/main/xfinity-data-usage)
[license-shield]: https://img.shields.io/github/license/zachowj/xfinity-data-usage.svg?style=for-the-badge
[release-link]: https://github.com/zachowj/xfinity-data-usage/releases
[release-shield]: https://img.shields.io/github/v/release/zachowj/xfinity-data-usage?style=for-the-badge
[docker-pulls]: https://img.shields.io/docker/pulls/zachowj/xfinity-data-usage?style=for-the-badge
[docker-link]: https://hub.docker.com/r/zachowj/xfinity-data-usage
[buymecoffee-link]: https://www.buymeacoffee.com/zachowj
[buymecoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png