rpiMySensorsIO

Project goal is to have JSON based configuration file which specifies how IO pins on (currently only RPI supported) MySensors platform will behave.

config.json

Format overview:

{
    "switches": {...},
    "inputs": {...},
    "inputPins": {...},
    "triggers": {...},
}

switches

Are the abstract configuration unit that specifies how output pin will behave.

example:

"switches": {
    "out1": {
        "mode": 0,
        "impulseDuration": 500,
        "pin": 11,
        "present": true
    },
    "out2": {
        "mode": 1,
        "impulseDuration": 500,
        "pin": "0.9",
        "feedbackPin": 2,
        "present": true
    }
}

description:

out1 - name of the switch. Send to MySensors controller if present is true.

mode:

• 0 : (default) standard mode if the switch is activated then output pin is set to state 1 until switch is active.
• 1 : impulse mode means that if the switch is activated or deactivated output pin will do impulse from 0 to 1 and back to 0 for impulseDuration specified time period

impulseDuration - (default: 300) only applied when mode is 1 (impulse) and its value specifies how long will impulse last

pin

• number : HW IO pin which will be used as output pin
• string :
  • format "0" same as number
  • format "0.0" first number means SPI0 connected device second number is HW output pin of SPI device.

feedbackPin

• not present or equal to 0: no feedback is used.
• number : HW IO pin which will be used as feedback input pin
• string :
  • format "0" same as number
  • format "0.0" first number means SPI0 connected device second number is HW input pin of SPI device.

present - (default: true) boolean property which specify if this switch will be presented (usable) in MySensors controller

inputs

Imputs related stuff

config

Shared configuration for input elements.

example:

"config": {
    "debounce": 50,
    "multiMaxDelay": 800
}

description:

debounce - debounce interval in ms

multiMaxDelay - maximum period in ms during which next press is counted into multipress signal

inputPins

Abstract configuration unit which specifies some properties of how input pin should behave.

example:

"inputPins": {
    "inPin7": {
        "pin": 7,
        "present": true
    },
    "inSPI02": {
        "present": true,
        "pin": "0.2"
    }
}

description:

inPin7 - name of the input pin. Used as identifier for triggers and is send to MySensors controller if present is true.

pin - WARNING internal pullup is used if pin is driven by button put other end of the button against the ground.

• number : HW IO pin which will be used as input pin.
• string :
  • format "0" same as number
  • format "0.0" first number means SPI0 connected device second number is HW input pin of SPI device.

present - (default: true) boolean property which specify if this input pin will be presented (usable) in MySensors controller

triggers

Abstract configuration unit which can specify how input actions are transformed to output.

example:

"vtl1": {
    "inPin": "inPin7",
    "event": 3,
    "count": 1,
    "drives": [
        {
            "switch": "out2",
            "action": 2
        }
    ]
}

description:

vtl1 - name of the trigger. Not used for presentation.

inPin - name of the input pin used for this trigger.

event - specifies which input pin event should this trigger listen to

• 0 (down) - the input pin sate goes to down
• 1 (up) - (default) the input pin state goes to up
• 2 (long) - the input pin state goes to long which means that input pin is activated for period more then multiMaxDelay specifies
• 3 (multi) - the input pin was pressed by property "count" specified times.

count - applies when trigger event multi is used and specifies count of pin activations to activate trigger

drives - array of objects which are driven by this trigger

• switch - name of the switch which is driven by this trigger
• action - specifies what shoud switch do after this trigger activation
  • 0 (toggle) - (default) switch is toggled
  • 1 (up) - switch is activated
  • 2 (down) - switch is deactivated

Future thoughts / ideas

MySensors controller uploadable config

Feature that will allow to upload configuration over MySensors network from MySensors controller to RPI. Started not finished yet.