DigKick (Backend) 1.0.0 documentation

DigKick (Backend) 1.0.0

Digital system for kicker tables.

Servers

mqtt://kicker.local/mqttemqx
The MQTT broker for development and production.
Security:
User/Password
Simple user password login to the broker.

Operations

RECEIVE /table/register
Operation for a registration of a table with an id
Operation IDkickerTableRegister
Available only on servers:
- emqx
Accepts the following message:
registerMessage
A message which contains the information for a table registration.
Message IDregisterMessage
object
Information for a table registration.

name
string
Additional properties are allowed.
Examples
{ "name": "table1" }

This example has been generated automatically.
RECEIVE /table/{tableName}/game/team/{teamColor}/button/{buttonId}
Action on button press
Operation IDbuttonPress
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
buttonId
required
string
Identifier of a button.

Examples values:
"1"
"2"
"3"
Accepts the following message:
pinOutMessage
Action triggered by a pin output change.
Message IDpinOutMessage
object
Defines the status of an analog or digital pin.

pinOut
string
Allowed values:
"HIGH"
"LOW"
Additional properties are allowed.
Examples
{ "pinOut": "HIGH" }

This example has been generated automatically.
RECEIVE /table/{tableName}/game/team/{teamColor}/light_barrier/{lightBarrierId}
Action on a detection of the light barrier
Operation IDlightBarrierDetect
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
lightBarrierId
required
string
Identifier of a light barrier.

Examples values:
"1"
"2"
Accepts the following message:
pinOutMessage
Action triggered by a pin output change.
Message IDpinOutMessage
object
Defines the status of an analog or digital pin.

pinOut
string
Allowed values:
"HIGH"
"LOW"
Additional properties are allowed.
Examples
{ "pinOut": "HIGH" }

This example has been generated automatically.
RECEIVE /table/{tableName}/game/team/{teamColor}/nfc-reader
Read nfc chip serial number for player registration.
Operation IDnfcReaderSerialUpdate
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
nfcReaderMessage
Information from the nfc reader about the chip.
Message IDnfcReaderMessage
object
serialNumber
string
Serial number of the read nfc chip

Additional properties are allowed.
Examples
{ "serialNumber": "serialNumberFromChip" }

This example has been generated automatically.
RECEIVE /table/{tableName}/game/team/{teamColor}/changename
Action to update the name of the player who registrated last to the table.
Operation IDplayerNameUpdate
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
newPlayerNameMessage
The new requested name for the last registered player.
Message IDnewPlayerNameMessage
object
newName
string
New name for the player

Additional properties are allowed.
Examples
{ "newName": "new player name" }

This example has been generated automatically.
SEND /table/{tableName}/game
Information about the game status.
Operation IDgameStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
Accepts the following message:
gameStatusMessage
All information about a team.
Message IDgameStatusMessage
object
Describes all information about a game.

gameMode
string
Allowed values:
"DEFAULT"
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
pointsToWin
number
>= 0
Additional properties are allowed.
Examples
{ "gameMode": "DEFAULT", "teamWhite": { "color": "white", "score": 4, "isWinner": false }, "teamBlack": { "color": "black", "score": 10, "isWinner": true }, "pointsToWin": 10 }

This example has been generated automatically.
SEND /table/{tableName}/game/team/{teamColor}
Information about the team.
Operation IDteamStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
teamMessage
All information about a team.
Message IDteamMessage
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
Examples
{ "color": "white", "score": 5, "isWinner": false }

This example has been generated automatically.
SEND /table/{tableName}/game/team/{teamColor}/color$
Information about the team color.
Operation IDteamColorStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
teamColorMessage
Information about the score of a team.
Message IDteamColorMessage
Payload
string
Allowed values:
"white"
"black"
Examples
white

This example has been generated automatically.
SEND /table/{tableName}/game/team/{teamteamColorId}/score$
Information about the team score.
Operation IDteamScoreStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
teamScoreMessage
Information about the score of a team.
Message IDteamScoreMessage
Payload
integer
>= 0
Examples
1
This example has been generated automatically.
SEND /table/{tableName}/game/team/winner
Information about the score status of the winner team. Payload is empty when there is no winner at the moment.
Operation IDwinnerTeamStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
teamMessage
All information about a team.
Message IDteamMessage
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
Examples
{ "color": "white", "score": 5, "isWinner": false }

This example has been generated automatically.
SEND /table/{tableName}/game/team/winner/color$
Information about the score status. Payload is empty when there is no winner at the moment.
Operation IDwinnerTeamColorStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
scoreStatusMessage
Information about the score of a team.
Message IDscoreStatusMessage
Payload
string
Allowed values:
"white"
"black"
Examples
white

This example has been generated automatically.
SEND /table/{tableName}/game/team/winner/score$
Information about the score status. Payload is empty when there is no winner at the moment.
Operation IDwinnerTeamScoreStatus
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
scoreStatusMessage
Information about the score of a team.
Message IDscoreStatusMessage
Payload
integer
>= 0
Examples
1
This example has been generated automatically.
SEND /table/{tableName}/game/team/{teamColor}/display
Display update
Operation IDdisplayUpdate
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
displayMessage
Updates the display with the given parameters.
Message IDdisplayMessage
object
Describes where to put which text on the OLED display

array<object>
Describes the different text segments for the display

object
Defines the position of the cursor (x|y)

cursorPosition
integer
2 items
The cursor position defines where the text is written on the display. First value = x position - Second value = y position

text
string
Defines the text.

inverted
boolean
Defines if the display should be inverted around the text.

Additional properties are allowed.
Additional properties are allowed.
Examples
{ "snippets": [ { "cursorPosition": [ 1, 2 ], "text": "WHITE 1 : 2 BLACK", "inverted": false }, { "cursorPosition": [ 1, 3 ], "text": "LAST SCORED: TEAM WHITE", "inverted": true } ] }

This example has been generated automatically.
SEND /table/{tableName}/game/team/{teamColor}/leds
LED(s) update
Operation IDledUpdate
Available only on servers:
- emqx
object
tableName
required
string
Identifier of a table.

Examples values:
"table1"
"kjb14123b1jk"
teamColor
required
string
Identifier of a team.

Examples values:
"white"
"black"
Accepts the following message:
ledMessage
Updates the LEDs strip.
Message IDledMessage
object
Describes how many LEDs are turned in which color(s). Also defines the transmission animation.

array<string>
>= 0 items
Describes the colors of the LEDs. The led strip should light in the described colors. If the value contains an empty string, the led at this place should be turned off.

Items:
string
Describes a color in HEX

animation
string
Describes the animation which gets played before the update of the LEDs.

Allowed values:
null
"GLACE GLIDER"
"NEON JUMP"
"NEON RUN LEFT"
"NEON RUN RIGHT"
"PARTY"
"FIREWORK"
Additional properties are allowed.
Examples
{ "colors": [ "0x00FF00", "0x00FFFF" ], "animation": "GLACE GLIDER" }

This example has been generated automatically.
SEND /api/player/all
Publishes all the players here.
Operation IDplayerScoreBoard
Available only on servers:
- emqx
Accepts the following message:
playerList
List of all players sorted by elo score.
Message IDplayerList
array<object>
object
id
number
Identifier of the entity

createdAt
string
Holds the date as string when this entity got created

updatedAt
string
Holds the date as string when this entity got updated the last time

elo
integer
Elo score of the player

name
string
Auto generated or set user name of the player

hashSerialNumber
string
Hashed serial number - only used on server - censored for frontend

Additional properties are allowed.
Examples
[ { "id": 3, "createdAt": "2024-06-17T22:04:32.000Z", "updatedAt": "2024-06-17T22:04:51.000Z", "elo": 69420, "name": "makoeta", "hashSerialNumber": "CENSORED" }, { "id": 1, "createdAt": "2024-06-17T19:49:17.000Z", "updatedAt": "2024-06-17T19:50:28.000Z", "elo": 3000, "name": "voma", "hashSerialNumber": "CENSORED" }, { "id": 2, "createdAt": "2024-06-17T19:49:19.000Z", "updatedAt": "2024-06-17T19:50:28.000Z", "elo": 84, "name": "random atze", "hashSerialNumber": "CENSORED" } ]

This example has been generated automatically.

Messages

#1tableRegisterMessage
A message which contains the information for a table registration.
Message IDtableRegisterMessage
object
Information for a table registration.

name
string
Additional properties are allowed.
#2gameMessage
All information about a team.
Message IDgameMessage
object
Describes all information about a game.

gameMode
string
Allowed values:
"DEFAULT"
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
pointsToWin
number
>= 0
Additional properties are allowed.
#3teamMessage
All information about a team.
Message IDteamMessage
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
#4teamColorMessage
Information about the score of a team.
Message IDteamColorMessage
Payload
string
Allowed values:
"white"
"black"
#5teamScoreMessage
Information about the score of a team.
Message IDteamScoreMessage
Payload
integer
>= 0
#6pinStatusMessage
Action triggered by a pin output change.
Message IDpinStatusMessage
object
Defines the status of an analog or digital pin.

pinOut
string
Allowed values:
"HIGH"
"LOW"
Additional properties are allowed.
#7displayUpdateMessage
Updates the display with the given parameters.
Message IDdisplayUpdateMessage
object
Describes where to put which text on the OLED display

array<object>
Describes the different text segments for the display

object
Defines the position of the cursor (x|y)

cursorPosition
integer
2 items
The cursor position defines where the text is written on the display. First value = x position - Second value = y position

text
string
Defines the text.

inverted
boolean
Defines if the display should be inverted around the text.

Additional properties are allowed.
Additional properties are allowed.
#8ledUpdateMessage
Updates the LEDs strip.
Message IDledUpdateMessage
object
Describes how many LEDs are turned in which color(s). Also defines the transmission animation.

array<string>
>= 0 items
Describes the colors of the LEDs. The led strip should light in the described colors. If the value contains an empty string, the led at this place should be turned off.

Items:
string
Describes a color in HEX

animation
string
Describes the animation which gets played before the update of the LEDs.

Allowed values:
null
"GLACE GLIDER"
"NEON JUMP"
"NEON RUN LEFT"
"NEON RUN RIGHT"
"PARTY"
"FIREWORK"
Additional properties are allowed.
#9nfcReaderMessage
Information from the nfc reader about the chip.
Message IDnfcReaderMessage
object
serialNumber
string
Serial number of the read nfc chip

Additional properties are allowed.
#10newPlayerNameMessage
The new requested name for the last registered player.
Message IDnewPlayerNameMessage
object
newName
string
New name for the player

Additional properties are allowed.
#11playerEntityListMessage
List of all players sorted by elo score.
Message IDplayerEntityListMessage
array<object>
object
id
number
Identifier of the entity

createdAt
string
Holds the date as string when this entity got created

updatedAt
string
Holds the date as string when this entity got updated the last time

elo
integer
Elo score of the player

name
string
Auto generated or set user name of the player

hashSerialNumber
string
Hashed serial number - only used on server - censored for frontend

Additional properties are allowed.

Schemas

gameMode
string
Allowed values:
"DEFAULT"
pinOut
string
Allowed values:
"HIGH"
"LOW"
object
Defines the status of an analog or digital pin.

pinOut
string
Allowed values:
"HIGH"
"LOW"
Additional properties are allowed.
object
Describes all information about a game.

gameMode
string
Allowed values:
"DEFAULT"
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
pointsToWin
number
>= 0
Additional properties are allowed.
object
Describes all information about a team.

color
string
Allowed values:
"white"
"black"
score
integer
>= 0
isWinner
boolean
Additional properties are allowed.
score
integer
>= 0
color
string
Allowed values:
"white"
"black"
object
serialNumber
string
Serial number of the read nfc chip

Additional properties are allowed.
object
newName
string
New name for the player

Additional properties are allowed.
object
Describes where to put which text on the OLED display

array<object>
Describes the different text segments for the display

object
Defines the position of the cursor (x|y)

cursorPosition
integer
2 items
The cursor position defines where the text is written on the display. First value = x position - Second value = y position

text
string
Defines the text.

inverted
boolean
Defines if the display should be inverted around the text.

Additional properties are allowed.
Additional properties are allowed.
object
Describes how many LEDs are turned in which color(s). Also defines the transmission animation.

array<string>
>= 0 items
Describes the colors of the LEDs. The led strip should light in the described colors. If the value contains an empty string, the led at this place should be turned off.

Items:
string
Describes a color in HEX

animation
string
Describes the animation which gets played before the update of the LEDs.

Allowed values:
null
"GLACE GLIDER"
"NEON JUMP"
"NEON RUN LEFT"
"NEON RUN RIGHT"
"PARTY"
"FIREWORK"
Additional properties are allowed.
id
number
Identifier of the entity
createdAt
string
Holds the date as string when this entity got created
updatedAt
string
Holds the date as string when this entity got updated the last time
object
id
number
Identifier of the entity

createdAt
string
Holds the date as string when this entity got created

updatedAt
string
Holds the date as string when this entity got updated the last time

elo
integer
Elo score of the player

name
string
Auto generated or set user name of the player

hashSerialNumber
string
Hashed serial number - only used on server - censored for frontend

Additional properties are allowed.
array<object>
object
id
number
Identifier of the entity

createdAt
string
Holds the date as string when this entity got created

updatedAt
string
Holds the date as string when this entity got updated the last time

elo
integer
Elo score of the player

name
string
Auto generated or set user name of the player

hashSerialNumber
string
Hashed serial number - only used on server - censored for frontend

Additional properties are allowed.

DigKick (Backend) 1.0.0

Servers

Security:

Operations

RECEIVE /table/register

Examples

This example has been generated automatically.

RECEIVE /table/{tableName}/game/team/{teamColor}/button/{buttonId}

Examples

This example has been generated automatically.

RECEIVE /table/{tableName}/game/team/{teamColor}/light_barrier/{lightBarrierId}

Examples

This example has been generated automatically.

RECEIVE /table/{tableName}/game/team/{teamColor}/nfc-reader

Examples

This example has been generated automatically.

RECEIVE /table/{tableName}/game/team/{teamColor}/changename

Examples

This example has been generated automatically.

SEND /table/{tableName}/game

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/{teamColor}

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/{teamColor}/color$

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/{teamteamColorId}/score$

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/winner

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/winner/color$

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/winner/score$

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/{teamColor}/display

Examples

This example has been generated automatically.

SEND /table/{tableName}/game/team/{teamColor}/leds

Examples

This example has been generated automatically.

SEND /api/player/all

Examples

This example has been generated automatically.

Messages

Schemas