ProDVX PuKK REST API Specification (1.0.3)

Download OpenAPI specification:

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

Static Led

Controls leds without movement

Turn Off

Turns the leds off

Authorizations:

None

Responses

Response samples

200
default

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Single Color

Sets all the leds to a single color

Authorizations:

None

Request Body schema: application/json

Static led values

required

object (LedStatic)

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"color": {"brightness": 100,
"red": 50,
"blue": 255,
"green": 255
},
"duration_ms": 0
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Quadrant

Set the leds to custom quadrants

Authorizations:

None

Request Body schema: application/json

Led object for quadrants

required

object (QuadrantRing)

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"quadrants": [{"brightness": 100,
"red": 50,
"green": 255,
"blue": 0
},
{"brightness": 100,
"red": 50,
"green": 255,
"blue": 0
},
{"brightness": 100,
"red": 50,
"green": 255,
"blue": 0
},
{"brightness": 100,
"red": 50,
"green": 255,
"blue": 0
}
],
"duration_ms": 0
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Individual control

Set leds individually

Authorizations:

None

Request Body schema: application/json

Led object for Individual Control

required

object (IndividualLeds)

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"colors": [{"brightness": 100,
"red": 255,
"green": 0,
"blue": 0
},
{"brightness": 100,
"red": 0,
"green": 255,
"blue": 0
},
{"brightness": 100,
"red": 0,
"green": 0,
"blue": 255
},
{"brightness": 100,
"red": 255,
"green": 255,
"blue": 255
},
{"brightness": 100,
"red": 255,
"green": 0,
"blue": 0
},
{"brightness": 100,
"red": 0,
"green": 255,
"blue": 0
},
{"brightness": 100,
"red": 0,
"green": 0,
"blue": 255
},
{"brightness": 100,
"red": 255,
"green": 255,
"blue": 255
},
{"brightness": 100,
"red": 255,
"green": 0,
"blue": 0
},
{"brightness": 100,
"red": 0,
"green": 255,
"blue": 0
},
{"brightness": 100,
"red": 0,
"green": 0,
"blue": 255
},
{"brightness": 100,
"red": 255,
"green": 255,
"blue": 255
}
],
"duration_ms": 0
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Dynamic Led

Controls led with movement

Marquee

Spins the Led around using single LED

Authorizations:

None

Request Body schema: application/json

Rotating led values

required

object (LedRotating)

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"color": {"brightness": 100,
"red": 50,
"blue": 255,
"green": 255
},
"duration_ms": 0,
"speed_ms": 100,
"counter_clockwise": false
}
}

Response samples

200
default

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Breathe

Set Leds to breathe with a color

Authorizations:

None

Request Body schema: application/json

Dynamic led values

required

object (LedDynamic)

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"color": {"brightness": 100,
"red": 50,
"blue": 255,
"green": 255
},
"duration_ms": 0,
"speed_ms": 100
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Clock

Set the leds to a ticking clock. The Clock starts on initial_color and move LED by LED (rotation_time_s / 12 for the amount of leds) to the end_color. The LED that is next to swap to end_color will have intermediate_color. This can be used to signify the current time. When the clock ends, the leds will stay on end_color.

Authorizations:

None

Request Body schema: application/json

Clock values

required

object (Clock)

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"initial_color": {"brightness": 100,
"red": 255,
"green": 0,
"blue": 0
},
"intermediate_color": {"brightness": 100,
"red": 0,
"green": 0,
"blue": 255
},
"end_color": {"brightness": 100,
"red": 0,
"green": 255,
"blue": 0
},
"rotation_time_s": 60,
"counter_clockwise": true
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Rainbow

This request makes a default rotating RGB rainbow.

Authorizations:

None

Request Body schema: application/json

Rainbow values

required

object

Responses

Request samples

Payload

Content type

application/json

{"led_values": {"brightness": 100,
"duration_ms": 0,
"speed_ms": 100,
"counter_clockwise": true
}
}

Response samples

200

Content type

application/json

{"status": "OK",
"message": "Leds successfully set to [100, 255, 255, 255]"
}

Update

Update the PuKK

OTA

Requests a OTA firmware update

Authorizations:

None

query Parameters

override_url

string

Example: override_url=http://www.example.com/firmware.bin

URL for overriding the OTA update

Responses

Response samples

200

Content type

application/json

{"status": "OK",
"message": "OTA update queued"
}