ch7465lg

package module

v0.0.0-...-2448ce1 Latest Latest Go to latest Published: Nov 8, 2020 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dstotijn/ch7465lg

Links

Open Source Insights

README ¶

CH7465LG

Go library and Prometheus exporter for the Compal CH7465LG cable modem (Ziggo ConnectBox).

Features

Metrics for bonded downstream channels

TODO

Expose metrics for bonded upstream channels

Installation

Build from source

Prerequisites

Go

$ GO111MODULE=on go get github.com/dstotijn/ch7465lg/cmd/ch7465lg

Usage


$ ch7465lg -h
Usage of ./ch7465lg:
-gw string
Modem gateway IP address. (default "192.168.178.1")
-prom string
Prometheus exporter bind address. (default ":9810")

The password for the modem admin user is read from a (required) MODEM_PASSWORD environment variable.

Acknowledgements

compal_CH7465LG_py: Helped me figure out that the order of POST form values matters.

License

MIT

Documentation ¶

Index ¶

Variables
type Client
- func NewClient(addr, password string, httpClient *http.Client) (*Client, error)
type Downstream
type FormValue
type FormValues
- func (v *FormValues) Add(key, value string)
- func (v FormValues) Encode() string

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrLoginFailed = errors.New("login failed")

ErrLoginFailed is returned when login failed, e.g. invalid credentials.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client represents a client for a CH7465LG modem.

func NewClient ¶

func NewClient(addr, password string, httpClient *http.Client) (*Client, error)

NewClient returns a new Client.

func (*Client) Downstreams ¶

func (c *Client) Downstreams() ([]Downstream, error)

Downstreams fetches statistics for bonded downstream channels.

func (*Client) Get ¶

func (c *Client) Get(funcNum int) (*http.Response, error)

Get retrieves settings.

func (c *Client) Login() error

Login performs a login attempt.

func (*Client) Logout ¶

func (c *Client) Logout() error

Logout ends the current session.

func (*Client) Set ¶

func (c *Client) Set(funcNum int, formValues FormValues) (*http.Response, error)

Set sends a mutation request.

type Downstream ¶

type Downstream struct {
	Frequency    int64   `xml:"freq"`
	Power        int     `xml:"pow"`
	SNR          int     `xml:"snr"`
	Modulation   string  `xml:"mod"`
	ChannelID    int     `xml:"chid"`
	RxMER        float64 `xml:"RxMER"`
	PreRSErrs    int64   `xml:"PreRs"`
	PostRSErrs   int64   `xml:"PostRs"`
	IsQamLocked  int     `xml:"IsQamLocked"`
	IsFECLocked  int     `xml:"IsFECLocked"`
	IsMpegLocked int     `xml:"IsMpegLocked"`
}

Downstream represents a bonded downstream channel.

type FormValue ¶

type FormValue struct {
	Key   string
	Value string
}

FormValue is used for submitting form values.

type FormValues ¶

type FormValues []FormValue

FormValues is used for submitting forms. Order matters, thus we cannot use a map (e.g. url.Values).

func (*FormValues) Add ¶

func (v *FormValues) Add(key, value string)

Add adds a form value.

func (FormValues) Encode ¶

func (v FormValues) Encode() string

Encode encodes the form values into “URL encoded” form ("bar=baz&foo=quux").

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
ch7465lg

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL