README
¶
xDSL Stats Parser
This is a library and application for reading basic xDSL stats, as well bitloading, SNR, QLN and Hlog data. It supports various kinds of modems (see below for details). The application includes a graphical user interface, but it can also be used via the command line, and a web interface is also available.
You just want to use the application?
Go here to download binaries for Linux, Windows and macOS.
You are a developer and want to build your own project based on the library?
Use the package 3e8.eu/go/dsl.
Note that there is no stable release yet, so incompatible changes should be expected occasionally.
Documentation
-
Getting started
Basic information about how to use the application. Includes tips for troubleshooting if it doesn't work right away. -
Supported devices
List of supported device types, including some device-specific notes for configuration. -
Configuration files
Description of all available options. Especially useful for the web server which can only be fully configured via config file. -
Building from source
Instructions for compiling the code yourself. Usually not necessary if binaries for your platform are available.
Documentation
¶
Index ¶
- Constants
- func RegisterClient(identifier ClientType, newFunc func(config Config) (Client, error), ...)
- type AuthTypes
- type AuthenticationError
- type Client
- type ClientDesc
- type ClientType
- type Config
- type ConnectionError
- type EncryptionPassphraseCallback
- type Option
- type OptionType
- type OptionValue
- type PasswordCallback
- type PrivateKeysCallback
- type Tristate
Constants ¶
const ( OptionTypeString = iota OptionTypeBool OptionTypeEnum )
Variables ¶
This section is empty.
Functions ¶
func RegisterClient ¶
func RegisterClient(identifier ClientType, newFunc func(config Config) (Client, error), desc ClientDesc)
RegisterClient registers a new device client. This function is not intended for use from external packages.
Types ¶
type AuthenticationError ¶
func (*AuthenticationError) Error ¶
func (e *AuthenticationError) Error() string
func (*AuthenticationError) Unwrap ¶
func (e *AuthenticationError) Unwrap() error
type Client ¶
type ClientDesc ¶
type ClientType ¶
type ClientType string
func GetClientTypes ¶
func GetClientTypes() []ClientType
func (ClientType) ClientDesc ¶
func (t ClientType) ClientDesc() ClientDesc
func (ClientType) IsValid ¶
func (t ClientType) IsValid() bool
type Config ¶
type Config struct {
Type ClientType
Host string
User string
AuthPassword PasswordCallback
AuthPrivateKeys PrivateKeysCallback
EncryptionPassphrase EncryptionPassphraseCallback
KnownHosts string
Options map[string]string
}
type ConnectionError ¶
type ConnectionError struct {
Err error
}
func (*ConnectionError) Error ¶
func (e *ConnectionError) Error() string
func (*ConnectionError) Unwrap ¶
func (e *ConnectionError) Unwrap() error
type EncryptionPassphraseCallback ¶
func EncryptionPassphrase ¶
func EncryptionPassphrase(passphrase string) EncryptionPassphraseCallback
type Option ¶
type Option struct {
Description string
Type OptionType
Values []OptionValue
}
type OptionType ¶
type OptionType int
type OptionValue ¶
type PasswordCallback ¶
func Password ¶
func Password(password string) PasswordCallback
type PrivateKeysCallback ¶
type PrivateKeysCallback struct {
Keys func() ([]string, error)
Passphrase func(fingerprint string) (string, error)
}
func PrivateKey ¶
func PrivateKey(key string, passphrase string) PrivateKeysCallback
Source Files
Directories