vigorv5

Documentation

Overview

Copyright 2018 Ben Kochie <superq@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2018 Ben Kochie <superq@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2018 Ben Kochie <superq@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type Status
• type Vigor
  • func New(logger log.Logger, host string, username string, password string) (*Vigor, error)
  • func (v *Vigor) FetchStatus() (Status, error)
  • func (v *Vigor) Login() error

Variables

var ErrJSONDecodeFailed = errors.New("json decode failed")

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

var ErrParseFailed = errors.New("dsl status parse failed")

var ErrRequestFailed = errors.New("failed to request with login")

var ErrUpdateFailed = errors.New("dsl status update failed")

Types

type Status

type Status struct {
	Status     string
	Mode       string
	Profile    string
	Annex      string
	DSLVersion string

	ActualRateDownstream     int
	ActualRateUpstream       int
	AttainableRateDownstream int
	AttainableRateUpstream   int
	SNRMarginDownstream      float64
	SNRMarginUpstream        float64
}

type Vigor

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

func New

func New(logger log.Logger, host string, username string, password string) (*Vigor, error)

func (*Vigor) FetchStatus

func (v *Vigor) FetchStatus() (Status, error)

func (*Vigor) Login

func (v *Vigor) Login() error