guh - Developer documentation

The guh library

Classes

Action

Holds information required to execute an action described by a ActionType

ActionType

Describes an Action for a Device

AvahiServiceEntry

Holds information about an avahi service entry

BluetoothScanner

Allows to discover bluetooth low energy devices

CoapObserveResource

Holds information about an observed resource

CoapOption

Represents the option of a CoapPdu

CoapPdu

Represents a CoAP protocol data unit (PDU)

CoapReply

Represents a reply of a CoAP request

CoapRequest

Represents a request to a CoAP server

CoreLink

Represents a link of a CoRE link format

CoreLinkParser

Provides an easy way to parse a CoRE link list

Device

A Device represents a installed and configured hardware device

DeviceClass

Describes Devices

DeviceDescriptor

Holds the description of a Device

DeviceManager

Main entry point when interacting with Devices

DevicePlugin

This is the base class interface for device plugins

Event

Holds information required to emit a event described by a EventType

EventDescriptor

Describes a certain Event

EventType

Describes a Event for a Device

Gpio

Allows to interact with the GPIOs

GpioMonitor

Allows to monitor GPIOs

GuhSettings

Settings class for guh

NetworkAccessManager

Allows to send network requests and receive replies

Param

Holds the parameters of a Param

ParamDescriptor

Describes a certain Param

ParamList

Holds a list of Params

ParamType

Describes a certain ParamType

QtAvahiService

Allows to publish an avahi service to the network

QtAvahiServiceBrowser

Allows to browse avahi services in the local network

Radio433

Helps to interact with the 433 MHz receiver and transmitter

RuleAction

Describes an action for a guhserver::Rule

RuleActionParam

Holds the parameters for a RuleAction

RuleActionParamList

Holds a list of RuleActionParams

State

Holds the parameters of a State of a Device

StateDescriptor

Describes a certain State

StateType

Describes the Type of a State from Device

UpnpDevice

Describes an UPnP device

UpnpDeviceDescriptor

Holds the description of an UPnP device

UpnpDiscovery

Allows to detect UPnP devices in the network

Vendor

Holds information about a the vendor of a Device

Types of libguh

Action

Holds information required to execute an action described by a ActionType

ActionType

Describes an Action for a Device

Event

Holds information required to emit a event described by a EventType

EventDescriptor

Describes a certain Event

EventType

Describes a Event for a Device

Param

Holds the parameters of a Param

ParamDescriptor

Describes a certain Param

ParamType

Describes a certain ParamType

RuleAction

Describes an action for a guhserver::Rule

RuleActionParam

Holds the parameters for a RuleAction

State

Holds the parameters of a State of a Device

StateDescriptor

Describes a certain State

StateType

Describes the Type of a State from Device

Vendor

Holds information about a the vendor of a Device

Device Plugins

Device

A Device represents a installed and configured hardware device

DeviceClass

Describes Devices

DeviceDescriptor

Holds the description of a Device

DeviceManager

Main entry point when interacting with Devices

DevicePlugin

This is the base class interface for device plugins

GuhSettings

Settings class for guh

Hardware Resources

BluetoothScanner

Allows to discover bluetooth low energy devices

Gpio

Allows to interact with the GPIOs

GpioMonitor

Allows to monitor GPIOs

NetworkAccessManager

Allows to send network requests and receive replies

QtAvahiServiceBrowser

Allows to browse avahi services in the local network

Radio433

Helps to interact with the 433 MHz receiver and transmitter

UpnpDiscovery

Allows to detect UPnP devices in the network

CoAP

CoapObserveResource

Holds information about an observed resource

CoapOption

Represents the option of a CoapPdu

CoapPdu

Represents a CoAP protocol data unit (PDU)

CoapReply

Represents a reply of a CoAP request

CoapRequest

Represents a request to a CoAP server

CoreLink

Represents a link of a CoRE link format

CoreLinkParser

Provides an easy way to parse a CoRE link list