Hangboard application 0.0.1 documentation

Hangboard application 0.0.1

GPLv3

Force sensing hangboard application. Backend communication protocol.

Servers

mqtt://t20mqttmosquitto

Operations

PUB hangboard/workout/control
Control the hangboard timer.
Operation IDonControlTimer
Accepts the following message:
ControlTimer
object
command
string
must match: ^Start .+$
Command.

Additional properties are allowed.
Examples
{ "command": "string" }

This example has been generated automatically.
SUB hangboard/workout/holds
Information on the currently used holds.
Operation IDGetConfiguredHolds
Accepts the following message:
Holds Used
object
time
integer
Timestamp in seconds.

left
string
Left hold.

Examples values:
"A1"
"A2"
right
string
Right hold.

Examples values:
"A7"
"A6"
Additional properties are allowed.
Examples
{ "time": 123412341234, "left": "A1", "right": "A7" }

This example has been generated automatically.
SUB hangboard/workout/workoutlist
List of all available workouts.
Operation IDGetWorkoutListe
Accepts the following message:
List of workouts.
object
time
integer
Timestamp in seconds.

Name
string
Name of the workout

Examples values:
"Strength 1"
"Endurance workout by Mr. X"
ID
string
Unique ID of the workout.

Examples values:
"HRST-S1"
"ZB-A12"
Filename
string
Filename containing the workout.

Examples values:
"myfile.json"
"abc/myfile2.json"
IndexInFile
integer
Index of the exercise in the given filename.

Examples values:
"myfile.json"
"abc/myfile2.json"
Additional properties are allowed.
Examples
{ "time": 123412341234, "Name": "Strength 1", "ID": "HRST-S1", "Filename": "myfile.json", "IndexInFile": "myfile.json" }

This example has been generated automatically.
SUB hangboard/workout/setinfo
Get information on the current set.
Operation IDGetSetInfo
Accepts the following message:
Current Set
object
time
integer
Timestamp in seconds.

resttostart
integer
>= 0
Rest to start time in seconds.

exercise
string
Exercise short description.

Examples values:
"Hang"
"Pull Up"
counter
integer
>= 0
How long to run in seconds or how much repetitions (for pull ups).

pause
integer
>= 0
Pause between the exercises in seconds.

reps
integer
>= 0
Number of exercise repetitions in this set.

left
string
Left hold to use.

Examples values:
"A1"
"JUG"
right
string
Right hold to use.

Examples values:
"A7"
"EDGE"
type
string
Type of exercise.

Examples values:
"Hang"
"Maximum Hang"
"Pull Up"
intensity
number
Maximal hang intensity if applicable for this exercise.

Additional properties are allowed.
Examples
{ "time": 123412341234, "resttostart": 5, "exercise": "Hang", "counter": 10, "pause": 5, "reps": 3, "left": "A1", "right": "A7", "type": "Hang", "intensity": 0 }

This example has been generated automatically.
SUB hangboard/workout/timerstatus
Information on the current timer status.
Operation IDGetCurrentTimerStatus
Accepts the following message:
Timer Status
object
time
integer
Timestamp in seconds.

Duration
number
Timer duration in seconds.

Elapsed
number
Timer elapsed time in seconds.

Completed
number
Relative completion of the current timer - elapsed / duration.

Countdown
number
Countdown number - count every second downwards. Will be -1, when no full second crossed.

Examples values:
-1
10
9
8
CurrentSet
integer
Current set index in this workout.

TotalSets
integer
Total sets in workout.

CurrentRep
integer
Current repetition index in this set.

TotalReps
integer
Total repetitions in this set.

Additional properties are allowed.
Examples
{ "time": 123412341234, "Duration": 20, "Elapsed": 3, "Completed": 0.8, "Countdown": -1, "CurrentSet": 1, "TotalSets": 5, "CurrentRep": 2, "TotalReps": 5 }

This example has been generated automatically.
SUB hangboard/workout/status
Current status of the workout backend.
Operation IDGetCurrentWorkoutStatus
Accepts the following message:
Workout Status
object
time
integer
Timestamp in seconds.

Duration
string
Timer duration in seconds.

Examples values:
"Starting"
"Cleanup"
Additional properties are allowed.
Examples
{ "time": 123412341234, "Duration": "Starting" }

This example has been generated automatically.
SUB hangboard/workout/workoutstatus
Current status of the current workout.
Operation IDGetCurrentWorkout
Accepts the following message:
Workout Description
object
time
integer
Timestamp in seconds.

Name
string
Name of the current workout.

Examples values:
"Stength Workout by Mr. Y"
"Endurance Workout by Mr. Z"
ID
string
Unique ID of the current workout.

Examples values:
"HRST-S-1"
"ZB-A-1"
Additional properties are allowed.
Examples
{ "time": 123412341234, "Name": "Stength Workout by Mr. Y", "ID": "HRST-S-1" }

This example has been generated automatically.
SUB hangboard/sensor/load/loadstatus
Information on the current load status including the calculated values.
Operation IDGetCurrentLoadStatus
Accepts the following message:
Load Status
object
time
integer
Timestamp in seconds.

loadcurrent
number
Current load in kg.

loadaverage
number
Average load in kg.

loadmaximal
number
Maximal load in kg.

loadloss
number
Relative loss of load - current / maximal.

fti
number
Force Time integral

rfd
number
Rate of force development

Additional properties are allowed.
Examples
{ "time": 123412341234, "loadcurrent": 23.2, "loadaverage": 55.3, "loadmaximal": 99.2, "loadloss": 0.2, "fti": 231.1, "rfd": 12.2 }

This example has been generated automatically.
SUB hangboard/sensor/sensorstatus
Current sensor status, i.e. hang status.
Operation IDGetCurrentSensorStatus
Accepts the following message:
Sensor Status
object
time
integer
Timestamp in seconds.

HangChangeDetected
string
Hang change detected.

Examples values:
"Hang"
"NoHang"
HangDetected
string
Hang change detected.

Examples values:
"True"
"False"
Additional properties are allowed.
Examples
{ "time": 123412341234, "HangChangeDetected": "Hang", "HangDetected": "True" }

This example has been generated automatically.
SUB hangboard/sensor/lastexercise
Summary of the last exercise.
Operation IDGetLastExerciseStatistics
Accepts the following message:
Last Exercise
object
time
integer
Timestamp in seconds.

LastHangTime
number
Last hang time in seconds.

LastPauseTime
number
Last pause time in seconds.

MaximalLoad
number
Maximal load in last exercise in kg.

Additional properties are allowed.
Examples
{ "time": 123412341234, "LastHangTime": 123, "LastPauseTime": 111, "MaximalLoad": 32 }

This example has been generated automatically.
SUB hangboard/workout/userstatistics
User statistics (i.e. intensity).
Operation IDGetUserStatistics
Accepts the following message:
User statistics.
object
time
integer
Timestamp in seconds.

CurrentIntensity
number
Current intensity - current load / maximal load - for a given hand and hold combination.

Examples values:
0.23
0.77
1.2
Additional properties are allowed.
Examples
{ "time": 123412341234, "CurrentIntensity": 0.23 }

This example has been generated automatically.
SUB hangboard/workout/upcoming
Upcoming workout data.
Operation IDGetUpcomingWorkoutData
Accepts the following message:
Upcoming workout data.
object
time
integer
Timestamp in seconds.

UpcomingSets
string
Upcoming set description.

Examples values:
"10x Hang for 5s with 20mm holds."
RemainingTime
string
Estimated rest time in the current workout.

Examples values:
12
2
Additional properties are allowed.
Examples
{ "time": 123412341234, "UpcomingSets": "10x Hang for 5s with 20mm holds.", "RemainingTime": 12 }

This example has been generated automatically.

Messages

#1ControlTimer
object
command
string
must match: ^Start .+$
Command.

Additional properties are allowed.
#2Holds Used
object
time
integer
Timestamp in seconds.

left
string
Left hold.

Examples values:
"A1"
"A2"
right
string
Right hold.

Examples values:
"A7"
"A6"
Additional properties are allowed.
#3List of workouts.
object
time
integer
Timestamp in seconds.

Name
string
Name of the workout

Examples values:
"Strength 1"
"Endurance workout by Mr. X"
ID
string
Unique ID of the workout.

Examples values:
"HRST-S1"
"ZB-A12"
Filename
string
Filename containing the workout.

Examples values:
"myfile.json"
"abc/myfile2.json"
IndexInFile
integer
Index of the exercise in the given filename.

Examples values:
"myfile.json"
"abc/myfile2.json"
Additional properties are allowed.
#4Current Set
object
time
integer
Timestamp in seconds.

resttostart
integer
>= 0
Rest to start time in seconds.

exercise
string
Exercise short description.

Examples values:
"Hang"
"Pull Up"
counter
integer
>= 0
How long to run in seconds or how much repetitions (for pull ups).

pause
integer
>= 0
Pause between the exercises in seconds.

reps
integer
>= 0
Number of exercise repetitions in this set.

left
string
Left hold to use.

Examples values:
"A1"
"JUG"
right
string
Right hold to use.

Examples values:
"A7"
"EDGE"
type
string
Type of exercise.

Examples values:
"Hang"
"Maximum Hang"
"Pull Up"
intensity
number
Maximal hang intensity if applicable for this exercise.

Additional properties are allowed.
#5Timer Status
object
time
integer
Timestamp in seconds.

Duration
number
Timer duration in seconds.

Elapsed
number
Timer elapsed time in seconds.

Completed
number
Relative completion of the current timer - elapsed / duration.

Countdown
number
Countdown number - count every second downwards. Will be -1, when no full second crossed.

Examples values:
-1
10
9
8
CurrentSet
integer
Current set index in this workout.

TotalSets
integer
Total sets in workout.

CurrentRep
integer
Current repetition index in this set.

TotalReps
integer
Total repetitions in this set.

Additional properties are allowed.
#6Workout Status
object
time
integer
Timestamp in seconds.

Duration
string
Timer duration in seconds.

Examples values:
"Starting"
"Cleanup"
Additional properties are allowed.
#7Workout Description
object
time
integer
Timestamp in seconds.

Name
string
Name of the current workout.

Examples values:
"Stength Workout by Mr. Y"
"Endurance Workout by Mr. Z"
ID
string
Unique ID of the current workout.

Examples values:
"HRST-S-1"
"ZB-A-1"
Additional properties are allowed.
#8Load Status
object
time
integer
Timestamp in seconds.

loadcurrent
number
Current load in kg.

loadaverage
number
Average load in kg.

loadmaximal
number
Maximal load in kg.

loadloss
number
Relative loss of load - current / maximal.

fti
number
Force Time integral

rfd
number
Rate of force development

Additional properties are allowed.
#9Sensor Status
object
time
integer
Timestamp in seconds.

HangChangeDetected
string
Hang change detected.

Examples values:
"Hang"
"NoHang"
HangDetected
string
Hang change detected.

Examples values:
"True"
"False"
Additional properties are allowed.
#10Last Exercise
object
time
integer
Timestamp in seconds.

LastHangTime
number
Last hang time in seconds.

LastPauseTime
number
Last pause time in seconds.

MaximalLoad
number
Maximal load in last exercise in kg.

Additional properties are allowed.
#11User statistics.
object
time
integer
Timestamp in seconds.

CurrentIntensity
number
Current intensity - current load / maximal load - for a given hand and hold combination.

Examples values:
0.23
0.77
1.2
Additional properties are allowed.
#12Upcoming workout data.
object
time
integer
Timestamp in seconds.

UpcomingSets
string
Upcoming set description.

Examples values:
"10x Hang for 5s with 20mm holds."
RemainingTime
string
Estimated rest time in the current workout.

Examples values:
12
2
Additional properties are allowed.

Hangboard application 0.0.1

Servers

Operations

PUB hangboard/workout/control

Examples

This example has been generated automatically.

SUB hangboard/workout/holds

Examples

This example has been generated automatically.

SUB hangboard/workout/workoutlist

Examples

This example has been generated automatically.

SUB hangboard/workout/setinfo

Examples

This example has been generated automatically.

SUB hangboard/workout/timerstatus

Examples

This example has been generated automatically.

SUB hangboard/workout/status

Examples

This example has been generated automatically.

SUB hangboard/workout/workoutstatus

Examples

This example has been generated automatically.

SUB hangboard/sensor/load/loadstatus

Examples

This example has been generated automatically.

SUB hangboard/sensor/sensorstatus

Examples

This example has been generated automatically.

SUB hangboard/sensor/lastexercise

Examples

This example has been generated automatically.

SUB hangboard/workout/userstatistics

Examples

This example has been generated automatically.

SUB hangboard/workout/upcoming

Examples

This example has been generated automatically.

Messages