vapor-ware / synse-docs Goto Github PK

The notion of "base" plugins should be documented, where a "base" plugin is a layer of abstraction on top of the SDK which may provide a base for a given class of plugins. This base can provide common utility functions, protocol handling, etc, and may define easier ways for "subclassed" plugins define devices / handlers / etc.

A good example of this is with the work around generalizing the SNMP plugin, where the "base" provides handling for the SNMP protocol handling and device config management, and "subclassed" plugins only need to define devices for their MIB(s).

the readme is currently stubbed out with TODOs -- it needs to be completed.

see: vapor-ware/synse-sdk#466

the example in the helm section (https://synse.readthedocs.io/en/latest/helm/) uses helm2 in the examples -- provide an equivalent helm3 example

vapor-ware/synse-sdk#450

e.g. the SDK plugin configuration page looks all messed up.. need to dig into what the cause of this is.

vapor-ware/synse-server#350

see: vapor-ware/synse-sdk#466

in the tutorial/examples, reading.Info is used -- this has been fixed to use context properly: vapor-ware/synse-sdk#427

update the example(s) accordingly

vapor-ware/synse-sdk#448

this will require updates to the synse server and sdk docs

new feature needs to be documented

see: vapor-ware/synse-server#372

vapor-ware/synse-server#360

vapor-ware/synse-server#375

https://github.com/vapor-ware/synse-sdk/blob/v3/staging/sdk/output/builtins.go