Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
/ bandwidthChecker Public archive

A tool for checking your used and remaining bandwith provided by your provider.

License

Notifications You must be signed in to change notification settings

depuits/bandwidthChecker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BandwidthChecker

A tool for checking your used and remaining bandwidth provided by your internet service provider. The data is displayed in gigabytes and accessible through a rest or mqtt interface as configured in your config.

Providers

Scarlet

Country: Belgium Config:

{
	name: 'scarlet',
	username: 'username',
	password: 'password'
}

Proximus

Country: Belgium Config:

{
	name: 'proximus',
	username: 'username',
	password: 'password'
}

Creating new providers

Providers can be added in lib\providers. This must implement a function getting the provider config and must return an object with a poll function. The poll function must return a promise returning the bandwidth info.

let bandwidthInfo = {
	used: 0, // Used bandwidth in gigabytes
	total: 0, // Total bandwidth available
	refreshDate: new Date() // Date when the used bandwidth resets
};

The data return by the Checker is the info retrieved by the provider. The Checker only fills in the lastUpdate field.

About

A tool for checking your used and remaining bandwith provided by your provider.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published