fritzbox_upnp

Documentation

Overview

Query UPNP variables from Fritz!Box devices.

Index

• Variables
• type Action
  • func (a *Action) Call() (Result, error)
  • func (a *Action) IsGetOnly() bool
• type Argument
• type Device
• type Result
• type Root
  • func LoadServices(device string, port uint16, username string, password string) (*Root, error)
• type Service
• type StateVariable

Variables

var ErrInvalidSOAPResponse = errors.New("invalid SOAP response")

Types

type Action

type Action struct {
	Name        string               `xml:"name"`
	Arguments   []*Argument          `xml:"argumentList>argument"`
	ArgumentMap map[string]*Argument // Map of arguments indexed by .Name
	// contains filtered or unexported fields
}

An UPNP Acton on a service

func (*Action) Call

func (a *Action) Call() (Result, error)

Call an action. Currently only actions without input arguments are supported.

func (*Action) IsGetOnly

func (a *Action) IsGetOnly() bool

Returns if the action seems to be a query for information. This is determined by checking if the action has no input arguments and at least one output argument.

type Argument

type Argument struct {
	Name                 string `xml:"name"`
	Direction            string `xml:"direction"`
	RelatedStateVariable string `xml:"relatedStateVariable"`
	StateVariable        *StateVariable
}

An Argument to an action

type Device

type Device struct {
	DeviceType       string `xml:"deviceType"`
	FriendlyName     string `xml:"friendlyName"`
	Manufacturer     string `xml:"manufacturer"`
	ManufacturerUrl  string `xml:"manufacturerURL"`
	ModelDescription string `xml:"modelDescription"`
	ModelName        string `xml:"modelName"`
	ModelNumber      string `xml:"modelNumber"`
	ModelUrl         string `xml:"modelURL"`
	UDN              string `xml:"UDN"`

	Services []*Service `xml:"serviceList>service"` // Service of the device
	Devices  []*Device  `xml:"deviceList>device"`   // Sub-Devices of the device

	PresentationUrl string `xml:"presentationURL"`
	// contains filtered or unexported fields
}

An UPNP Device

type Result

type Result map[string]interface{}

The result of a Call() contains all output arguments of the call. The map is indexed by the name of the state variable. The type of the value is string, uint64 or bool depending of the DataType of the variable.

type Root

type Root struct {
	BaseUrl  string
	Username string
	Password string
	Device   Device              `xml:"device"`
	Services map[string]*Service // Map of all services indexed by .ServiceType
}

Root of the UPNP tree

func LoadServices

func LoadServices(device string, port uint16, username string, password string) (*Root, error)

Load the services tree from an device.

type Service

type Service struct {
	Device *Device

	ServiceType string `xml:"serviceType"`
	ServiceId   string `xml:"serviceId"`
	ControlUrl  string `xml:"controlURL"`
	EventSubUrl string `xml:"eventSubURL"`
	SCPDUrl     string `xml:"SCPDURL"`

	Actions        map[string]*Action // All actions available on the service
	StateVariables []*StateVariable   // All state variables available on the service
}

An UPNP Service

type StateVariable

type StateVariable struct {
	Name         string `xml:"name"`
	DataType     string `xml:"dataType"`
	DefaultValue string `xml:"defaultValue"`
}

A state variable that can be manipulated through actions