https://github.com/seydx/homebridge-broadband

Homebridge Plugin for Broadband speed measurement as Temperature sensor
https://github.com/seydx/homebridge-broadband

broadband fakegato homebridge plugin speedtest

Last synced: 14 days ago
JSON representation

Homebridge Plugin for Broadband speed measurement as Temperature sensor

• Host: GitHub
• URL: https://github.com/seydx/homebridge-broadband
• Owner: seydx
• License: mit
• Created: 2018-03-26T18:14:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-02T14:20:29.000Z (over 1 year ago)
• Last Synced: 2024-10-04T14:40:56.399Z (about 1 month ago)
• Topics: broadband, fakegato, homebridge, plugin, speedtest
• Language: JavaScript
• Size: 9.91 MB
• Stars: 15
• Watchers: 9
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# homebridge-broadband v1

Homebridge Plugin for Broadband speed measurement as Temperature sensor

[![npm](https://img.shields.io/npm/v/homebridge-broadband.svg?style=flat-square)](https://www.npmjs.com/package/homebridge-broadband)

[![npm](https://img.shields.io/npm/dt/homebridge-broadband.svg?style=flat-square)](https://www.npmjs.com/package/homebridge-broadband)

[![GitHub last commit](https://img.shields.io/github/last-commit/SeydX/homebridge-broadband.svg?style=flat-square)](https://github.com/SeydX/homebridge-broadband)

# Homebridge plugin for checking your broadband speed

This homebridge plugin exposes a new temperature sensor to HomeKit to see your broadband speed at home. It also has new characteristics to see the download- and upload speed, also your ping within i.e. Elgato EVE app. It also supports Fakegato.

See [Images](https://github.com/SeydX/homebridge-broadband/tree/master/images/) for more details.

# Installation instructions

After [Homebridge](https://github.com/nfarina/homebridge) has been installed:

 ```sudo npm install -g homebridge-broadband@latest --unsafe-perm```

 

 

 ## Example config.json:

 ```

{

  "bridge": {

      ...

  },

  "accessories": [

    {

      "accessory": "Broadband",

      "name": "Broadband",

      "maxTime": 5,

      "interval": 60

    }

  ]

}

```

## Options

| **Attributes** | **Required** | **Usage** |

|------------|----------|-------|

| accessory | **Yes** | Must be "Broadband" |

| name | No | Name for the Accessory (Default: Broadband) |

| maxTime | No | The maximum length of a single test run in seconds (Default: 5s) |

| interval | No | Interval for checing the broadband in mins (Default: 60min) |

See [Example Config](https://github.com/SeydX/homebridge-broadband/blob/master/example-config.json) for more details.

## Supported clients

This plugin have been verified to work with the following apps on iOS 11.2.5:

* Apple Home

* Elgato Eve 

## Known issues | TODO

///

## Contributing

You can contribute to this homebridge plugin in following ways:

- [Report issues](https://github.com/SeydX/homebridge-broadband/issues) and help verify fixes as they are checked in.

- Review the [source code changes](https://github.com/SeydX/homebridge-broadband/pulls).

- Contribute bug fixes.

- Contribute changes to extend the capabilities

Pull requests are accepted.