input

Documentation

Overview

BlueZ D-Bus Input API description [input-api.txt]

Index

• Variables
• type Input1
  • func NewInput1(objectPath dbus.ObjectPath) (*Input1, error)
  • func (a *Input1) Client() *bluez.Client
  • func (a *Input1) Close()
  • func (a *Input1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)
  • func (a *Input1) GetProperties() (*Input1Properties, error)
  • func (a *Input1) GetPropertiesSignal() (chan *dbus.Signal, error)
  • func (a *Input1) GetProperty(name string) (dbus.Variant, error)
  • func (a *Input1) GetReconnectMode() (string, error)
  • func (a *Input1) GetWatchPropertiesChannel() chan *dbus.Signal
  • func (a *Input1) Interface() string
  • func (a *Input1) Path() dbus.ObjectPath
  • func (a *Input1) SetProperty(name string, value interface{}) error
  • func (a *Input1) SetReconnectMode(v string) error
  • func (a *Input1) SetWatchPropertiesChannel(c chan *dbus.Signal)
  • func (a *Input1) ToProps() bluez.Properties
  • func (a *Input1) UnwatchProperties(ch chan *bluez.PropertyChanged) error
  • func (a *Input1) WatchProperties() (chan *bluez.PropertyChanged, error)
• type Input1Properties
  • func (a *Input1Properties) FromDBusMap(props map[string]dbus.Variant) (*Input1Properties, error)
  • func (a *Input1Properties) FromMap(props map[string]interface{}) (*Input1Properties, error)
  • func (p *Input1Properties) Lock()
  • func (a *Input1Properties) ToMap() (map[string]interface{}, error)
  • func (p *Input1Properties) Unlock()

Variables

var Input1Interface = "org.bluez.Input1"

Types

type Input1

type Input1 struct {
	Properties *Input1Properties
	// contains filtered or unexported fields
}

Input1 Input hierarchy

func NewInput1

func NewInput1(objectPath dbus.ObjectPath) (*Input1, error)

NewInput1 create a new instance of Input1

Args: - objectPath: [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX

func (*Input1) Client

func (a *Input1) Client() *bluez.Client

Client return Input1 dbus client

func (*Input1) Close

func (a *Input1) Close()

Close the connection

func (*Input1) GetObjectManagerSignal

func (a *Input1) GetObjectManagerSignal() (chan *dbus.Signal, func(), error)

GetObjectManagerSignal return a channel for receiving updates from the ObjectManager

func (*Input1) GetProperties

func (a *Input1) GetProperties() (*Input1Properties, error)

GetProperties load all available properties

func (*Input1) GetPropertiesSignal

func (a *Input1) GetPropertiesSignal() (chan *dbus.Signal, error)

GetPropertiesSignal return a channel for receiving udpdates on property changes

func (*Input1) GetProperty

func (a *Input1) GetProperty(name string) (dbus.Variant, error)

GetProperty get a property

func (*Input1) GetReconnectMode

func (a *Input1) GetReconnectMode() (string, error)

GetReconnectMode get ReconnectMode value

func (*Input1) GetWatchPropertiesChannel

func (a *Input1) GetWatchPropertiesChannel() chan *dbus.Signal

GetWatchPropertiesChannel return the dbus channel to receive properties interface

func (*Input1) Interface

func (a *Input1) Interface() string

Interface return Input1 interface

func (*Input1) Path

func (a *Input1) Path() dbus.ObjectPath

Path return Input1 object path

func (*Input1) SetProperty

func (a *Input1) SetProperty(name string, value interface{}) error

SetProperty set a property

func (*Input1) SetReconnectMode

func (a *Input1) SetReconnectMode(v string) error

SetReconnectMode set ReconnectMode value

func (*Input1) SetWatchPropertiesChannel

func (a *Input1) SetWatchPropertiesChannel(c chan *dbus.Signal)

SetWatchPropertiesChannel set the dbus channel to receive properties interface

func (*Input1) ToProps

func (a *Input1) ToProps() bluez.Properties

ToProps return the properties interface

func (*Input1) UnwatchProperties

func (a *Input1) UnwatchProperties(ch chan *bluez.PropertyChanged) error

func (*Input1) WatchProperties

func (a *Input1) WatchProperties() (chan *bluez.PropertyChanged, error)

WatchProperties updates on property changes

type Input1Properties

type Input1Properties struct {

	/*
		ReconnectMode Determines the Connectability mode of the HID device as
				defined by the HID Profile specification, Section 5.4.2.

				This mode is based in the two properties
				HIDReconnectInitiate (see Section 5.3.4.6) and
				HIDNormallyConnectable (see Section 5.3.4.14) which
				define the following four possible values:

				"none"		Device and host are not required to
						automatically restore the connection.

				"host"		Bluetooth HID host restores connection.

				"device"	Bluetooth HID device restores
						connection.

				"any"		Bluetooth HID device shall attempt to
						restore the lost connection, but
						Bluetooth HID Host may also restore the
						connection.
	*/
	ReconnectMode string
	// contains filtered or unexported fields
}

Input1Properties contains the exposed properties of an interface

func (*Input1Properties) FromDBusMap

func (a *Input1Properties) FromDBusMap(props map[string]dbus.Variant) (*Input1Properties, error)

FromDBusMap convert a map to an Input1Properties

func (*Input1Properties) FromMap

func (a *Input1Properties) FromMap(props map[string]interface{}) (*Input1Properties, error)

FromMap convert a map to an Input1Properties

func (*Input1Properties) Lock

func (p *Input1Properties) Lock()

Lock access to properties

func (*Input1Properties) ToMap

func (a *Input1Properties) ToMap() (map[string]interface{}, error)

ToMap convert a Input1Properties to map

func (*Input1Properties) Unlock

func (p *Input1Properties) Unlock()

Unlock access to properties