Resources

Description

The Home2L Resources library.

The API exports a large number of low-level C/C++ functions and classes, which in many cases are not relevant for rules scripts or Python-based drivers and are not documented in detail here. As a rule of thumb, the level of documentation reflects the relevance of some function.

The most common functions can be found in section Main API. Besides this, the classes CResource (Resource Objects) and CRcValueState (Values, Types and States) are important for accessing the data transported via resource objects.

Most of the information presented here is also available as Python docstrings (avaliable via help(<name>) in a Python shell). Additional information can be found in the C/C++ API documentation.

Collaboration diagram for Resources:

Modules
	Main API
	Top-level functionality of the Resources library - most commonly used functions can be found here.
	Values, Types and States
	Basic definitions for values and their types and state.
	Resource Objects
	Accessing resource objects.
	Directory Services
	Querying local metadata (for interactive debugging).
	Subscriptions
	Low-level access to the C/C++ subscriber classes.
	Requests
	Low-level access to the C/C++ request class.
	Drivers in C/C++
	Native API for defining custom drivers.