Description

Placing requests to change resource values.

Collaboration diagram for Requests:

Classes
class	CRcRequest
	Request description object. More...

Typedefs
typedef CDict< CRcRequest >	CRcRequestSet
	Set of requests (for CResource::GetRequestSet() )

Functions
const char *	RcGetUserRequestId ()
	Get the request ID for user interactions (see 'rc.userReqId'). More...

const char *	RcGetUserRequestAttrs ()
	Get the default request attributes for user interactions (see 'rc.userReqAttrs'). More...

Variables
const char *const	rcDefaultRequestId
	Request ID for default requests ("default")

Request Priorities
Request priorities are in the range from 0..9, and the following constants define some recommended values. For writable resources, their drivers should set a permanent request at prio 0 for the default value. If no default is set, this lib will keep the last value if the last request is removed.
#define	rcPrioMin 0
	Minimum (lowest) priority.

#define	rcPrioNormal 3
	General default for new requests and default for automation rules.

#define	rcPrioMax 9
	Maximum (highest) priority.

#define	rcPrioDefault 0
	Preset defaults (typically by the driver)

#define	rcPrioRuleMin 1
	Minimum for automation rules.

#define	rcPrioRule 3
	Default for automation rules.

#define	rcPrioRuleMax 5
	Maximum for automation rules (unless safety-relevant, see rcPrioSafety)

#define	rcPrioUser 6
	Direct user interaction (e.g. user pushes button to open window shades)

#define	rcPrioShell 7
	Shell or administrative interaction (default priority in the Home2l shell)

#define	rcPrioSafety 8
	Automatic actions necessary to avoid damage (e.g. close roof window on bad weather)

#define	rcPrioIKnowWhatImDoing 9
	Maximum priority is reserved for explicit manual intervention (should not be used by any automation rule)

#define	rcPrioNone -1
	Undefined priority (special value)

Function Documentation

const char * RcGetUserRequestId ( )

Get the request ID for user interactions (see 'rc.userReqId').

Get the configured request ID for user interactions.

const char * RcGetUserRequestAttrs ( )

Get the default request attributes for user interactions (see 'rc.userReqAttrs').

Get the configured request attributes for user interactions.