Provider

Methods

setAttributeValue

setAttributeValue(attribute: string, value: any): Promise<void>;

This will set the value of an attribute and publish it to the MQTT broker. The attribute is the name of the attribute as defined in the definition file of your package (optional).

setAvailability

setAvailability(availability: boolean): Promise<void>;

This will set the availability of the device and publish the changes to MQTT. Setting availability to false will mark the device and any attributes having availability as unavailable in Home Assistant.

getConfig

getConfig(): any;

This will return the configuration of the device as defined in the QuantumHub configuration file. It is returned as an object.

`provider.cache`

set

set(key: string, value: any): Promise<void>;

Sets a value in the cache, linked to your device. This value will be saved in a SQLite database. The key needs to be unique, otherwise it will overwrite the existing value.

get

get(key: string): Promise<any>;

Gets a value from the cache based on the provided key, if no value is found it will return undefined.

delete

delete(key: string): Promise<void>;

Deletes a value from the cache based on the provided key.

all

all(): Promise<{ [key: string]: any }>;

Gets all values from the cache as an object.

`provider.timeout`

The timeout manager in the Provider is used to schedule tasks to run after a certain amount of time. This is useful for things like debouncing button presses or setting a value to an attribute after a certain amount of time. This uses the setTimeout and clearTimeout functions, but makes sure that the timeouts are cleared when the device is stopped/destroyed.

set

set(callback: () => Promise<void>, timeout: number): NodeJS.Timeout;

clear

clear(timeoutId: NodeJS.Timeout): Promise<void>;

`provider.logger`

The logger is used to make sure that the device is able to log messages to the console but also when you are looking at the logs using the webinterface. Logged messages are not stored anywhere.

Make sure you select the log level, as this can easily cause a lot of log spam.

trace(message: string): Promise<void>;
debug(message: string): Promise<void>;
info(message: string): Promise<void>;
warn(message: string): Promise<void>;
error(message: string): Promise<void>;
fatal(message: string): Promise<void>;

`provider.mqtt`

This gives you access to the MQTT client that is used by QuantumHub.

subscribeToTopic

subscribeToTopic(topic: string): Promise<void>;

Subscribe to a specific topic, this will trigger the onMessage event on the device.

publishToTopic

publishToTopic(topic: string, message: string, retain: boolean): Promise<void>;

Allows you to manually publish a message to a specific topic.

`provider.definition`

The definition object gives you access to the values you defined in your packages definition file.

export interface Definition {
    path: string;

    name: string;
    entry: string;
    author?: string;
    description?: string;
    version?: string;

    attributes: Attribute[];
}

Device Attributes