platform_driver.interfaces.restful module

class platform_driver.interfaces.restful.Interface(**kwargs)[source]

Bases: platform_driver.interfaces.BasicRevert, platform_driver.interfaces.BaseInterface

configure(config_dict, registry_config_str)[source]

Configures the Interface for the specific instance of a device.

  • config_dict (dict) – The “driver_config” section of the driver configuration file.

  • registry_config_str (str) – The contents of the registry configuration file.

This method must setup register representations of all points on a device by creating instances of BaseRegister (or a subclass) and adding them to the Interface with BaseInterface.insert_register().

get_point(point_name, **kwargs)[source]

Get the current value for the point name given.

  • point_name (str) – Name of the point to retrieve.

  • kwargs – Any interface specific parameters.


Point value

class platform_driver.interfaces.restful.Register(read_only, volttron_point_name, units, description, point_name)[source]

Bases: platform_driver.interfaces.BaseRegister