Announcement

Collapse
No announcement yet.

Strugling with finding references or documentation

Collapse
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

    Strugling with finding references or documentation

    I have been trying to update my plugin but keep struggling with finding out about the new concepts such as features, etc.
    I've been using https://homeseer.github.io/ for both the API and Docs as well as searching the forum and using the samples. I've made progress but it has been luck.
    I've got my plugin more or less working but it has all been by examples, searches, etc.

    I would like to know where I can find documentation on..
    1. Basic HS command such as GetRefsByInterface or UpdateDeviceByRef. I've only seen it in the forums.
    2. How to update an HS Device via the plugin for values, notes, etc. I am sure it has to do with properties but I can't find where the properties are listed/documented.
    3. if someone can provide me with a simple example on how to turn an HS device to "On" that would be great.
    I know this info is somewhere but I am struggling to find it.
    I appreciate the help.
    James

    Running HS 3 on Win10 .

    #2
    Start at https://homeseer.github.io/Plugin-SD...api/index.html
    Navigate to iHSContoller methods. This will give you all the things for #1.
    https://homeseer.github.io/Plugin-SD...r.html?tabs=cs

    For #2 there is the general case and then some shortcut methods. The general case is
    hs.GetPropertyByRef(dvRef, Homeseer.PluginSdk.Devices.Eproperty.###) and an equivalent hs.UpdatePropertyByRef where ### is the enumeration of properties. In the case of DeviceValue it will be "Value" and for DeviceString it will be "Status". For Address it will be "Address". The shortcuts for Value and String are hs.UpdateFeatureValueByRef(dvRef,value) and hs.UpdateFeatureValueStringByRef(dvRef,value). Equivalent UpdateDeviceValueByRef and UpdateDeviceValueStringByRef.

    For #3 it is not clear what you are really asking. The plugin turns its features on and off and updates the Feature Value to reflect the state that should be reflected in the HS UI. The pluign responds to others turning it on and off via the same CAPI mechanism used in HS3. Little has changed in that area.




    Comment


      #3
      Thank you Michael. I am grateful. Your answer to #2 really answers my #3. I am not sure why I couldn't find the info. I appreciate you taking the time.
      James

      Running HS 3 on Win10 .

      Comment

      Working...
      X