api

Documentation

Overview

Package chargepoint provides a native client library wrapping the "ChargePoint Web Services API Version 5.0".

Note that any comments quoted from the API Guide are indicated as such, and will be quoted verbatim.

TODO(james): Add more detail to the package comment, including examples of how to use the library.

Index

• func NewClient(url, apiKey, apiPassword string, httpLogWriter io.Writer) *client
• func NewHandler(server ChargePointServer) http.Handler
• type ChargePointServer

Functions

func NewClient

func NewClient(url, apiKey, apiPassword string, httpLogWriter io.Writer) *client

NewCliant returns a new client instance that communicates with the given SOAP Endpoint (`url`) with the given ChargePoint API credentials. A record of every HTTP exchange will be written to `httpLogWriter`, in JSONL format.

Note that the ChargePoint Web Services API is a SOAP v1.1 endpoint protected by a WS-Security "UsernameToken". The username is the API license key, and the password is the API password.

func NewHandler

func NewHandler(server ChargePointServer) http.Handler

Types

type ChargePointServer

type ChargePointServer interface {
	GetLoad(*schema.GetLoadRequest) (*schema.GetLoadResponse, error)
	GetStations(*schema.GetStationsRequest) (*schema.GetStationsResponse, error)
	GetStationGroups(*schema.GetStationGroupsRequest) (*schema.GetStationGroupsResponse, error)
	GetCPNInstances(*schema.GetCPNInstancesRequest) (*schema.GetCPNInstancesResponse, error)
	ShedLoad(*schema.ShedLoadRequest) (*schema.ShedLoadResponse, error)
	ClearShedState(*schema.ClearShedStateRequest) (*schema.ClearShedStateResponse, error)
}