Skip to content

yPluginApi

Sébastien Gallou edited this page Jun 14, 2016 · 4 revisions

The plugin API provides some services to plugins :

  • Declaring, checking if already declared, getting details on devices and keywords
  • Getting the event handler, used to wait events from Yadoms or from your plugin (timer, data reception...)
  • Indicating the plugin current state to Yadoms
  • Recording (= historizing) new data acquisitions
  • Getting the informations (provided in the package.json) about the plugin
  • Getting the current configuration of the plugin instance

See IYPluginApi.h file for full API documentation (located in yadoms/sources/shared/shared/plugin/yPluginApi).

Clone this wiki locally