Skip to content

Latest commit

 

History

History
65 lines (56 loc) · 6 KB

README.md

File metadata and controls

65 lines (56 loc) · 6 KB

DarknessBotGarmin

A Garmin companion app for DarknessBot.

Requirements

  • macOS 11.0 or newer
  • DarknessBot 7.3 or newer (for testing)

Build

./kumitateru build --target fenix3
  • Build app for all models: Run build.command
  • Built app .prg files will be available in build folder

Messaging Protocol

Incoming message to Garmin App

Field name Type Required Description
connected Int * Connection status for transport. 1 - connected, 2 - disconnected
remaining Double Remainig mileage in km
totalMileage Double Total mileage in km
battery Double Battery level in %
current Double Amperage in A
singleMaxSpeed Double Max speed of trip in kph
isImperialUnit Int Is enabled imperial unit on iOS app. 1 - enabled, 0 - disabled
isFahrenheitUnit Int Is enabled Fahrenheit unit on iOS app. 1 - enabled, 0 - disabled
avgSpeed Double Avarage speed in kph
voltage Double Voltage in V
distance Double Trip mileage in km
temperature Double Temperature of mainboard in °C
power Double Motor power in W
speed Double Speed in kph
maxCurrent Double Max amperage for connected transport in A
maxSpeed Double Max speed for connected transport in kph
pwm Double PWM (duty cycle) in %
settings Dictionary Settings dictionary
settings.beep Int Is beep option available for connected transport. 1 - available, 0 - unavailable
settings.lights Int Is lights option status for connected transport. 1 - active, 0 - inactive, null - unavailable
settings.limit Int Is limit speed mode option status for connected transport. 1 - active, 0 - inactive, null - unavailable
settings.lock Int Is lock option status for connected transport. 1 - active, 0 - inactive, null - unavailable
settings.musicVolumeControl Int Is music volume control option status on iOS app. 1 - active, 0 - inactive, null - unavailable
settings.strobe Int Is strobe option status for connected transport. 1 - active, 0 - inactive, null - unavailable
settings.torch Int Is torch option status for connected transport. 1 - active, 0 - inactive, null - unavailable
settings.tracker Int Is tracker option status on iOS app. 1 - active, 0 - inactive, null - unavailable
settings.turnOff Int Is turn off option available for connected transport. 1 - available, 0 - unavailable

Outgoing message from Garmin App

Action (String format) Description
beep Beep signal on transport
torch Switch torch for transport on/off
strobe Switch strobe mode for transport on/off
turnOff Turning off transport
tracker Switch tracker mode for iOS app on/off
lock Switch lock mode for transport on/off
limit Switch limit speed mode for transport on/off
musicVolumeControl Switch music volume control mode for iOS app on/off