rest

Documentation

Index

• type Battery
• type Grid
• type InputState
• type Inverter
  • func (settings *Inverter) GetBatteryCapacity() (int, error)
  • func (settings *Inverter) GetLimitToLoad() (bool, error)
  • func (settings *Inverter) SetBatteryCapacity(batteryCap int) error
  • func (settings *Inverter) SetLimitToLoad(limitToLoad bool) error
• type Load
• type SynkClient
  • func Authenticate(ctx context.Context, config *configuration.Configuration) (*SynkClient, error)
  • func (synkClient *SynkClient) ListInverters(ctx context.Context) ([]string, error)
  • func (synkClient *SynkClient) ReadBattery(ctx context.Context) (*Battery, error)
  • func (synkClient *SynkClient) ReadGrid(ctx context.Context) (*Grid, error)
  • func (synkClient *SynkClient) ReadInputState(ctx context.Context) (*InputState, error)
  • func (synkClient *SynkClient) ReadInverterSettings(ctx context.Context) (*Inverter, error)
  • func (synkClient *SynkClient) ReadLoad(ctx context.Context) (*Load, error)
  • func (synkClient *SynkClient) UpdateInverterSettings(ctx context.Context, settings *Inverter) error
• type SynkObject
  • func (synkObject *SynkObject) Get(key string) (any, bool)
  • func (s SynkObject) String() string
  • func (synkObject *SynkObject) Update(key string, value any) error
• type SynkResponse

Types

type Battery

type Battery struct{ *SynkObject }

type Grid

type Grid struct{ *SynkObject }

type InputState

type InputState struct{ *SynkObject }

type Inverter

type Inverter struct{ *SynkObject }

func (*Inverter) GetBatteryCapacity

func (settings *Inverter) GetBatteryCapacity() (int, error)

func (*Inverter) GetLimitToLoad

func (settings *Inverter) GetLimitToLoad() (bool, error)

func (*Inverter) SetBatteryCapacity

func (settings *Inverter) SetBatteryCapacity(batteryCap int) error

func (*Inverter) SetLimitToLoad

func (settings *Inverter) SetLimitToLoad(limitToLoad bool) error

type Load

type Load struct{ *SynkObject }

type SynkClient

type SynkClient struct {
	SerialNumber string
	// contains filtered or unexported fields
}

func Authenticate

func Authenticate(ctx context.Context, config *configuration.Configuration) (*SynkClient, error)

func (*SynkClient) ListInverters

func (synkClient *SynkClient) ListInverters(ctx context.Context) ([]string, error)

func (*SynkClient) ReadBattery

func (synkClient *SynkClient) ReadBattery(ctx context.Context) (*Battery, error)

func (*SynkClient) ReadGrid

func (synkClient *SynkClient) ReadGrid(ctx context.Context) (*Grid, error)

func (*SynkClient) ReadInputState

func (synkClient *SynkClient) ReadInputState(ctx context.Context) (*InputState, error)

func (*SynkClient) ReadInverterSettings

func (synkClient *SynkClient) ReadInverterSettings(ctx context.Context) (*Inverter, error)

func (*SynkClient) ReadLoad

func (synkClient *SynkClient) ReadLoad(ctx context.Context) (*Load, error)

func (*SynkClient) UpdateInverterSettings

func (synkClient *SynkClient) UpdateInverterSettings(ctx context.Context, settings *Inverter) error

type SynkObject

type SynkObject map[string]any

func (*SynkObject) Get

func (synkObject *SynkObject) Get(key string) (any, bool)

func (SynkObject) String

func (s SynkObject) String() string

func (*SynkObject) Update

func (synkObject *SynkObject) Update(key string, value any) error

type SynkResponse

type SynkResponse struct {
	Code    int            `json:"code"`
	Message string         `json:"msg"`
	Data    map[string]any `json:"data"`
	Success bool           `json:"success"`
}