pimatic: providing devices in a plugin

actions.coffee

class MyDevice extends env.devices.Device

  actions: 
    turnOn:
      description: "turns the switch on"
    turnOff:
      description: "turns the switch off"
    changeStateTo:
      description: "changes the switch to on or off"
      params:
        state:
          type: Boolean

  # Returns a promise
  turnOn: -> @changeStateTo on

  # Retuns a promise
  turnOff: -> @changeStateTo off

  # Retuns a promise that is fulfilled when done.
  changeStateTo: (state) -> #...

attribute-emit.coffee

  inSomeFunctionOfMyPlugin: =>
    # Got a new value, so emit it to the framework:
    @emit "temperature", 20

attributes.coffee

class MyDevice extends env.devices.Device

  attributes:
    temperature:
      description: "the messured temperature"
      type: Number
      unit: '°C'

  getTemperature: -> Promise.resolve(30)
  

device-constructor.coffee

class MyDevice extends env.devices.Device
 
    # ####constructor()
    # Your constructor function must assign a name and id to the device.
    constructor: (@config) ->
      @name = @config.name
      @id = @config.id
      # ...
      super()

providing-devices.coffee

module.exports = (env) ->

  class MyPlugin extends env.plugins.Plugin

    init: (app, @framework, config) =>
      # ...

      deviceConfigDef = require("./device-config-schema")

      @framework.deviceManager.registerDeviceClass("MySwitch", {
        configDef: deviceConfigDef.MySwitch, 
        createCallback: (config) => new MySwitch(config)
      })


  class MySwitch extends env.devices.PowerSwitch
    # ...

  myPlugin = new MyPlugin
  return myPlugin

switch-device.coffee

class MySwitch extends env.devices.PowerSwitch

    # ####constructor()
    # Your constructor function must assign a name and id to the device.
    constructor: (@config) ->
      @name = @config.name
      @id = @config.id
      # ...

temperature-sensor.coffee

class YourTemperatureSensor extends env.devices.TemperatureSensor
  temperature: null

  constructor: (@config) ->
    @name = "some name or from config"
    @id = "some-id"
    # update the temperature every 5 seconds
    setInterval( ( => 
      @doYourStuff()
    ), 5000)

  doYourStuff: () ->
    # temperature = ...
    @temperature = temperature
    @emit "temperature", temperature

  getTemperature: -> Promise.resolve(@temperature)

template.coffee

class MyCustomDevice extends env.devices.Device
  # [...]
  getTemplateName: -> "customdevice"

There is a typo in the template.coffe. getTemplateName: -> "customdevice"needs to be getTemplate: -> "customdevice".