logo
API docs by Redocly

ProDVX PuKK Events (1.0.3)

Download OpenAPI specification:

ProDVX Support: support@prodvx.com License: ProDVX Proprietary License

Introduction

This document describes the outgoing requests of the PuKK Workspace. Using the response, you can control the LEDs of the PuKK

Events

Polling event

Authorizations:
None
query Parameters
action
required
string
Value: "poll"

Type of action

mac
required
string
Example: mac=10:20:30:40:50:60

Mac address of the PuKK.

Responses

Response samples

Content type
application/json
Example
{
  • "command": "set_leds",
  • "led_values": {
    }
}

Event called upon input

Authorizations:
None
query Parameters
action
string
Enum: "short_press" "double_press" "multiple_press" "long_press_3s" "long_press_5s" "long_press_15s" "nfc"

Type of action. Multiple_press is 3 or more presses until the user stops pressing.

mac
string
Example: mac=10:20:30:40:50:60

Mac address of the PuKK.

Request Body schema: application/json
optional

Required when action=nfc, Empty otherwise

One of
dataType
string
Enum: "Text" "JSON" "URI" "VCard"

Data type of the values

nfcId
string

NFC Identifier

nfcValue
string

Value on the NFC

object

Responses

Request samples

Content type
application/json
Example
{
  • "dataType": "Text",
  • "nfcId": "string",
  • "nfcValue": "string",
  • "nfcSpecs": {
    }
}

Response samples

Content type
application/json
Example
{
  • "command": "set_leds",
  • "led_values": {
    }
}