package
0.0.0-20200821104852-f76c6d292a95
Repository: https://github.com/jvanderl/flogo-components.git
Documentation: pkg.go.dev

# README

BLE Subscriber (Master)

This trigger provides your flogo application the ability to start a flow via Bluetooth Low Energy Where Flogo is the BLE master, inititating connection to the BLE device.

Installation

flogo install github.com/jvanderl/flogo-components/trigger/blemaster

Link for flogo web:

https://github.com/jvanderl/flogo-components/trigger/blemaster

Schema

Settings, Outputs and Endpoint:

{
  "name": "blemaster",
  "version": "0.0.1",
  "type": "flogo:trigger",
  "description": "Bluetooth Low Energy Master",
  "author": "Jan van der Lugt <[email protected]>",
  "settings":[
    {
      "name": "devicename",
      "type": "string"
    },
    {
      "name": "deviceid",
      "type": "string"
    },
    {
      "name": "autodisconnect",
      "type": "boolean"
    },    {
      "name": "autoreconnect",
      "type": "boolean"
    },
    {
      "name": "reconnectinterval",
      "type": "integer"
    },
    {
      "name": "intervaltype",
      "type": "string",
      "allowed" : ["hours", "minutes", "seconds", "milliseconds"]
    }
  ],
  "output": [
    {
      "name": "notification",
      "type": "string"
    },
    {
      "name": "deviceid",
      "type": "string"
    },
    {
      "name": "localname",
      "type": "string"
    }
  ],
  "handler": {
    "settings": [
      {
        "name": "service",
        "type": "string"
      },
      {
        "name": "characteristic",
        "type": "string"
      }
    ]
  }
}

Settings

SettingDescription
devicenameThe Local Name of the BLE device. Leave empty to discover just the services in the handler section
autodisconnectAutomatically disconnect after data from all characteristics is received
autoreconnectAutomatically reconnect after device is disconnected
reconnectintervalHow long to wait before attempting to reconnect
intervaltypeUnit of time used by reconnectinterval

Ouputs

OutputDescription
notificationThe data sent by the BLE device

Handlers

SettingDescription
serviceThe BLE Service that exposes the data
characteristicThe BLE characteristic under the service stated above

Example Configurations

Triggers are configured via the triggers.json of your application. The following are some example configuration of the BLE Master Trigger.

Start a flow

Configure the Trigger to start "testFlow". So in this case the "handlers" "settings" "devicename" is emplty, so it will start "testFlow" flow when a message arrives on characteristic "ffe1" exposed under sevice "ffe0" from any device in this case.

{
  "name": "blemaster",
  "settings": {
    "devicename": "",
		"autoreconnect": "true",
		"reconnectinterval": "5",
		"intervaltype": "seconds"
  },
  "handlers": [
    {
      "actionId": "local://testFlow",
      "settings": {
        "service": "ffe0",
				"characteristic": "ffe1"
      }
    }
  ]
}

# Functions

NewFactory create a new Trigger factory.

# Structs

BleMaster Trigger factory.
No description provided by the author
No description provided by the author
MyTrigger is a stub for your Trigger implementation.
StartRequest describes a request for starting a ProcessInstance.