Index: sources/cloudsync/CloudSyncController.h =================================================================== diff -u -r9363dbc93c2be5d664c0ca2a565d8206679d9bf3 -r472c10e72a8d278f13d2343f9c81c1def14490ff --- sources/cloudsync/CloudSyncController.h (.../CloudSyncController.h) (revision 9363dbc93c2be5d664c0ca2a565d8206679d9bf3) +++ sources/cloudsync/CloudSyncController.h (.../CloudSyncController.h) (revision 472c10e72a8d278f13d2343f9c81c1def14490ff) @@ -33,6 +33,94 @@ /*! * \brief The CloudSyncController class * \details Singleton class which is the main gateway of CloudSync signal/slots. + * \startuml + * title CloudSync Buff communication protocol + * participant HD + * queue CAN + * database FS + * participant UI + * database BUF + * participant CS + * participant DRT + * participant DCS + * + * skinparam sequenceMessageAlign left + * + * === - Manufacturing - === + * == CMDx1 - Registration == + * UI -> BUF : log:\n[1001] Registration Request + * BUF -> CS : notify + * CS -> DRT : + * DRT -> DCS : + * DCS -> DRT : DONE + * DCS -> CS : DONE + * + * == CMDx3 - Credentials - Save == + * DCS -> CS : credentials + * CS -> FS : write:\n - path_to_client_certificate_pem,\n - client_private_key_pem\n - client_public_key_pem + * CS -> BUF : log:\n[2003] Credentials Store Request\n - path_to_client_certificate_pem\n - path_to_client_private_key_pem\n - path_to_client_public_key_pem + * BUF -> UI : notify + * UI -> FS : write:\nStore it in the encrypted partition + * UI -> BUF : log:\n[1003] Credentials Store Response + * + * == CMDx4 - Credentials - Read == + * CS -> DCS : start a Session + * DCS -> CS : authentication request + * CS -> BUF : log:\n[2004] Credentials Read Request + * BUF -> UI : notify + * UI -> FS : copy credentials on tmp + * UI -> BUF : log:\n[1004] Credentials Read Response\n - path_to_credentials + * BUF -> CS : notify + * CS -> FS : read credentials + * CS -> DCS : authentication response + * + * == CMDx5 - Factory Reset == + * DCS -> CS : Registration Complete + * CS -> BUF : log:\n[2005] Factory Reset Request + * BUF -> UI : notify + * UI -> FS : factory reset: clear the related information from the system. + * UI -> BUF : log:\n[1002] Factory Reset Response + * BUF -> CS : notify + * + * === - Normal Operation - === + * + * == CMDx7 - Send Treatment Report == + * CS -> BUF : log:\n[2002] Device Info Request + * BUF -> UI : notify + * UI -> BUF : log:\n[1002] Device Info Response \n - HD Serial\n - DG Serial\n - SW Version + * BUF -> CS : notify + * + * == CMDx6 - Device State == + * CS -> BUF : log:\n[2006] Device State Request + * HD -> CAN : msg:\n[0x37] Device State Broadcast + * CAN -> UI : notify + * UI -> BUF : log:\n[1006] Device State (Top History)\n - HD Op-Mode\n - HD Sub-Mode + * BUF -> CS : notify + * CS -> BUF : read:\n[1002] Device State + * CS -> DCS : + * + * == CMDx7 - Send Tx Report == + * + * == CMDx8 - Tx Code Display == + * + * \enduml + * + * \startuml + * title "Device Management flow" + * + * actor User + * database System + * + * user -> qml : set vATTRIBUTE + * qml -> VDevice : vATTRIBUTE##Request + * VDevice -> DeviceController : didAttributeRequest \n(cosnt Device##vATTRIBUTE##RequestData &) + * DeviceController -> Script : onAttributeRequest \n(const Device##vATTRIBUTE##RequestData &) + * Script -> system : + * system -> Script + * + * \enduml + * + */ class CloudSyncController : public QObject { Q_OBJECT