BaSe PCU-Protokoll / API (WIP)

[M-Welsch]

0 Meta

0.1 Generelles Format der Nachrichten

<set/get/cmd> <args>

0.2 Erläuterungen zu den Typen

Es gibt 3 Typen

1. set: setzt einen Wert. Bspw. set hmi display brightness 100
2. get: gibt einen Wert zurück. Bspw get dockingstate
3. cmd: führt einen Befehl aus. Bspw cmd dock

Darüber hinaus den Speziallbefehl

4. probe: schickt einfach echo zurück

1 Auflistung der Nachrichten

1.1 Shutdown-Kontrolle

1.1.1 Shutdown Initiieren

cmd shutdown init

Die PCU wartet eine gewisse Zeit, schaltet dann die Stromversorgung für die BCU ab und begibt sich dann selbst in den Deep Sleep

1.1.2 Shutdown abbrechen

cmd shutdown abort

Die PCU bricht den zuvor gestarteten Shutdown-Timer ab und begibt sich in den Normalbetrieb

1.2 Zeit

aktuelle Zeit setzen oder zurücklesen

set date now yyyy mm dd HH MM
get date now

aufweck-Zeit setzen oder zurücklesen

set date wakeup yyyy mm dd HH MM
get date wakeup

Backup Zeit setzen oder zurücklesen

set date backup yyyy mm dd HH MM
get date backup

1.3 Wakeup Reason

get wakeupreason

gibt einen dieser Strings als Grund zurück

• scheduled wenn der Aufwachzeitpunkt geplant war
• requeted wenn über die Hardware HMI angefordert
• poweron das ist der default. Kann geschickt werden, falls die Hardware zum ersten Mal Strom bekommt

[MaximilianStaab]

[M-Welsch]

as implemented in https://github.com/M-Welsch/base-pcu/commit/1bcf86ef7c2da93b7d4f2d11f121926b35f2a567

graph LR

failed[return commandname failed]
success[return commandname succesul]
true[return true]
false[return false]

av[returns analog value]
probe-->echo[return echo]
input-->get
get-->analog
analog-->imotor_prot-->av
analog-->stator_supply_sense-->av
analog-->vin12_meas-->av
get-->digital
digital-->endswitch
endswitch-->true
endswitch-->false
digital-->docked
docked-->true
docked-->false
get-->dockingstate
get-->date
get-->version

input-->set
set-->date

input-->cmd
cmd-->dock
dock-->failed
dock-->success
cmd-->undock
undock-->failed
undock-->success
cmd-->power
power-->hdd
hdd-->on
on-->failed
on-->success
hdd-->off
off-->failed
off-->success
power-->bcu
bcu-->on
bcu-->off