proxy

Documentation

Overview

Package proxy implements a REST API for sending commands to Tesla vehicles.

See the Fleet API documentation for available endpoints.

Index

• Constants
• Variables
• func ExtractCommandAction(ctx context.Context, command string, params RequestParameters) (func(*vehicle.Vehicle) error, error)
• type Proxy
  • func New(ctx context.Context, skey protocol.ECDHPrivateKey, cacheSize int) (*Proxy, error)
  • func (p *Proxy) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type RequestParameters
• type Response

Constants

const (
	DefaultTimeout = 10 * time.Second
)

Variables

var (
	// ErrCommandNotImplemented indicates a command has not be implemented in the SDK
	ErrCommandNotImplemented = errors.New("command not implemented")

	// ErrCommandUseRESTAPI indicates vehicle/command is not supported by the protocol
	ErrCommandUseRESTAPI = errors.New("command requires using the REST API")
)

Functions

func ExtractCommandAction

func ExtractCommandAction(ctx context.Context, command string, params RequestParameters) (func(*vehicle.Vehicle) error, error)

ExtractCommandAction use command to define which action should be executed.

Types

type Proxy

type Proxy struct {
	Timeout time.Duration
	// contains filtered or unexported fields
}

Proxy exposes an HTTP API for sending vehicle commands.

func New

func New(ctx context.Context, skey protocol.ECDHPrivateKey, cacheSize int) (*Proxy, error)

New creates an http proxy.

Vehicles must have the public part of skey enrolled on their keychains. (This is a command-authentication key, not a TLS key.)

func (*Proxy) ServeHTTP

func (p *Proxy) ServeHTTP(w http.ResponseWriter, req *http.Request)

type RequestParameters

type RequestParameters map[string]interface{}

RequestParameters allows simple type check

type Response

type Response struct {
	Response   interface{} `json:"response"`
	Error      string      `json:"error"`
	ErrDetails string      `json:"error_description"`
}

Response contains a server's response to a client request.