jamesnetherton / homehub-client

Golang client for the BT Home Hub router

Home Hub Client

A golang client that can interact with BT Home Hub routers. Refer to the compatibility matrix to see the firmware versions supported by each release. The master branch is currently proven against firmware versions SG4B1000B540 and SG4B1A006100.

At present, only a small set of the available APIs have been implemented.

If you're looking for a command line implementation of this library, check out my Home Hub CLI. There's also a Prometheus exporter that's loosely based on this client code.

Usage

package main

import (
	"fmt"
	"github.com/jamesnetherton/homehub-client"
)

func main() {
	hub := homehub.New("http://192.168.1.254", "admin", "p4ssw0rd")
	hub.Login()

	version, err := hub.Version()
	if err == nil {
		fmt.Printf("Home Hub Version = %s", version)
	}
}

homehub-client's Issues

Add support for firmware SG4B1A006100

Test against older versions of Home Hubs

No idea how the APIs are implemented in previous hub versions, so would be useful to test against one of them.

Bandwidth monitor request sends invalid date strings

Explains why no content is being returned from the request:

"parameters":{"startDate":"201744","endDate":"201744"}}

Ensure user is authenticated before attempting to make HTTP requests

Improve error handling

Some of the response handlers make the assumptions that all of the relevant bits of the JSON response will be available. This may not always be the case and it can lead to a nil pointer dereference.

Enhance mock HTTP test server so that it can record router responses

Better to record (or re-record) router responses in case the firmware has changed.

Challenge is how to automatically obfuscate sensitive info in the JSON responses like:

• MAC IDs
• SSIDs
• IP Addresses
• Passwords

Implement some means of generating API functions

It should be possible to generate the code (including test cases) for most of the simple XPath API calls

Migrate build config to CircleCI v2

The library modifies the global "log" config

I noticed that this library, when included, will modify the global "log" object, meaning I'm not able to log anything after calling homehub.New.

I think a better idea is to have a public global variable e.g. var Debug bool which determines whether debug prints are logged.

Paginated event log

Right now EventLog returns the entire log. It'd be nice if chunks of it could be returned either by line number or event timestamp.

Migrate CI build to GitHub actions

All the methods return strings

I wanted to use this library for a small project, but I find it a bit strange all the methods actually return string instead of something more structured. It would be far more useful if e.g. ConnectedDevices returned a slice of structs that I could enumerate in order to get information about a particular device.