envoy

package module
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 11, 2025 License: MIT Imports: 16 Imported by: 2

README

Go client for Envoy Gateway

Simple Go library to interact with your local Envoy Gateway. The main consumer of this library is promethues-envoy-exporter

License

License is MIT

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var NilNotification = nilNotification{}

Functions

func GetJWTExpired added in v0.0.13 

func GetJWTExpired(rawToken string) (*time.Time, error)

Types

type Battery added in v0.1.0 

type Battery struct {
	EnchgGridMode        string   `json:"Enchg_grid_mode,omitempty"`
	EnpwrCurrStateID     int      `json:"Enpwr_curr_state_id,omitempty"`
	EnpwrGridMode        string   `json:"Enpwr_grid_mode,omitempty"`
	EnpwrRelayStateBm    int      `json:"Enpwr_relay_state_bm,omitempty"`
	AdminState           int      `json:"admin_state"`
	AdminStateStr        string   `json:"admin_state_str"`
	BmuFwVersion         string   `json:"bmu_fw_version,omitempty"`
	CommLevel24Ghz       int      `json:"comm_level_2_4_ghz"`
	CommLevelSubGhz      int      `json:"comm_level_sub_ghz"`
	Communicating        bool     `json:"communicating"`
	CreatedDate          int      `json:"created_date"`
	DcSwitchOff          bool     `json:"dc_switch_off"`
	DerIndex             int      `json:"der_index,omitempty"`
	DeviceStatus         []string `json:"device_status"`
	EnchargeCapacity     int      `json:"encharge_capacity,omitempty"`
	EnchargeRev          int      `json:"encharge_rev,omitempty"`
	ImgLoadDate          int      `json:"img_load_date"`
	ImgPnumRunning       string   `json:"img_pnum_running"`
	Installed            int      `json:"installed"`
	LastRptDate          int      `json:"last_rpt_date"`
	LedStatus            int      `json:"led_status,omitempty"`
	MainsAdminState      string   `json:"mains_admin_state,omitempty"`
	MainsOperState       string   `json:"mains_oper_state,omitempty"`
	MaxCellTemp          int      `json:"maxCellTemp,omitempty"`
	PartNum              string   `json:"part_num"`
	PercentFull          int      `json:"percentFull,omitempty"`
	Phase                string   `json:"phase,omitempty"`
	ReportedEncGridState string   `json:"reported_enc_grid_state,omitempty"`
	SerialNum            string   `json:"serial_num"`
	SleepEnabled         bool     `json:"sleep_enabled"`
	Temperature          int      `json:"temperature"`
}

type Client 

type Client struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(username, password, serial string, opts ...OptionFunc) (*Client, error)

func (*Client) Batteries added in v0.1.0 

func (c *Client) Batteries() (*[]Battery, error)

func (*Client) CommCheck added in v0.0.9 

func (c *Client) CommCheck() (*CommCheckResponse, error)

func (*Client) InvalidateSession added in v0.0.6 

func (c *Client) InvalidateSession()

func (*Client) Inverters added in v0.0.8 

func (c *Client) Inverters() (*[]Inverter, error)

func (*Client) Production 

func (c *Client) Production() (*ProductionResponse, error)

type CommCheckResponse added in v0.0.9 

type CommCheckResponse map[string]int

type DiscoverResponse added in v0.0.12 

type DiscoverResponse struct {
	IPV4         string
	IPV6         string
	Serial       string
	ProtoVersion string
}

func Discover added in v0.0.10 

func Discover() (*DiscoverResponse, error)

type HTTPClient added in v0.2.0 

type HTTPClient struct {
	http.Client
}

HTTPClient is a wrapper around net/http.Client with improved defaults and error handling.

func NewHTTPClient added in v0.2.0 

func NewHTTPClient(timeout time.Duration) *HTTPClient

NewHTTPClient creates a new HTTPClient with sensible timeouts and keep-alive settings.

func (*HTTPClient) ResetCookieJar added in v0.2.0 

func (c *HTTPClient) ResetCookieJar()

type InventoryResponse added in v0.1.0 

type InventoryResponse []struct {
	Batteries []Battery `json:"devices"`
	Type      string    `json:"type"`
}

type Inverter added in v0.0.8 

type Inverter struct {
	SerialNumber    string `json:"serialNumber"`
	LastReportDate  int    `json:"lastReportDate"`
	DevType         int    `json:"devType"`
	LastReportWatts int    `json:"lastReportWatts"`
	MaxReportWatts  int    `json:"maxReportWatts"`
}

type Line 

type Line struct {
	WNow             float64 `json:"wNow"`
	WhLifetime       float64 `json:"whLifetime"`
	VarhLeadLifetime float64 `json:"varhLeadLifetime"`
	VarhLagLifetime  float64 `json:"varhLagLifetime"`
	VahLifetime      float64 `json:"vahLifetime"`
	RmsCurrent       float64 `json:"rmsCurrent"`
	RmsVoltage       float64 `json:"rmsVoltage"`
	ReactPwr         float64 `json:"reactPwr"`
	ApprntPwr        float64 `json:"apprntPwr"`
	PwrFactor        float64 `json:"pwrFactor"`
	WhToday          float64 `json:"whToday"`
	WhLastSevenDays  float64 `json:"whLastSevenDays"`
	VahToday         float64 `json:"vahToday"`
	VarhLeadToday    float64 `json:"varhLeadToday"`
	VarhLagToday     float64 `json:"varhLagToday"`
}

type LoginResponse 

type LoginResponse struct {
	Message      string `json:"message"`
	SessionId    string `json:"session_id"`
	ManagerToken string `json:"manager_token"`
	IsConsumer   bool   `json:"is_consumer"`
}

type Measurement 

type Measurement struct {
	Type             string  `json:"type"`
	ActiveCount      int     `json:"activeCount"`
	ReadingTime      int     `json:"readingTime"`
	WNow             float64 `json:"wNow"`
	WhLifetime       float64 `json:"whLifetime"`
	MeasurementType  string  `json:"measurementType,omitempty"`
	VarhLeadLifetime float64 `json:"varhLeadLifetime,omitempty"`
	VarhLagLifetime  float64 `json:"varhLagLifetime,omitempty"`
	VahLifetime      float64 `json:"vahLifetime,omitempty"`
	RmsCurrent       float64 `json:"rmsCurrent,omitempty"`
	RmsVoltage       float64 `json:"rmsVoltage,omitempty"`
	ReactPwr         float64 `json:"reactPwr,omitempty"`
	ApprntPwr        float64 `json:"apprntPwr,omitempty"`
	PwrFactor        float64 `json:"pwrFactor,omitempty"`
	WhToday          float64 `json:"whToday,omitempty"`
	WhLastSevenDays  float64 `json:"whLastSevenDays,omitempty"`
	VahToday         float64 `json:"vahToday,omitempty"`
	VarhLeadToday    float64 `json:"varhLeadToday,omitempty"`
	VarhLagToday     float64 `json:"varhLagToday,omitempty"`
	Lines            []Line  `json:"lines,omitempty"`
}

type Notification added in v0.0.6 

type Notification interface {
	JWTRefreshed(string)
	JWTError(error)
	SessionRefreshed(string)
	SessionUsed(string)
	SessionError(error)
}

type OptionFunc 

type OptionFunc func(*Client) error

func WithDebug added in v0.0.4 

func WithDebug(debug bool) OptionFunc

func WithEnlightenBase 

func WithEnlightenBase(enlightenBase string) OptionFunc

func WithGatewayAddress 

func WithGatewayAddress(address string) OptionFunc

func WithJWT added in v0.0.13 

func WithJWT(rawToken string) OptionFunc

func WithNotification added in v0.0.6 

func WithNotification(notification Notification) OptionFunc

type ProductionResponse 

type ProductionResponse struct {
	Production  []Measurement `json:"production"`
	Consumption []Measurement `json:"consumption"`
	Storage     []Storage     `json:"storage"`
}

type Storage 

type Storage struct {
	Type        string  `json:"type"`
	ActiveCount int     `json:"activeCount"`
	ReadingTime int     `json:"readingTime"`
	WNow        float64 `json:"wNow"`
	WhNow       float64 `json:"whNow"`
	State       string  `json:"state"`
}

type TokenResponse 

type TokenResponse struct {
	GenerationTime int64  `json:"generation_time"`
	Token          string `json:"token"`
	ExpiresAt      int64  `json:"expires_at"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.