From 6ff30ee384152d58583528c6d0c84dad9dd24a81 Mon Sep 17 00:00:00 2001 From: joekolodz Date: Sat, 26 Mar 2022 13:31:17 -0500 Subject: [PATCH] add comments to clarify Overlay and Merge method; add first draft docs --- docs/diagrams/src/models-class.puml | 64 ++++++++++++++ docs/diagrams/src/models-component.puml | 65 ++++++++++++++ docs/diagrams/src/sequence.puml | 112 ++++++++++++++++++++++++ src/App.xaml | 2 +- src/Models/HOTASDevice.cs | 10 +++ src/ViewModels/DeviceViewModel.cs | 2 +- 6 files changed, 253 insertions(+), 2 deletions(-) create mode 100644 docs/diagrams/src/models-class.puml create mode 100644 docs/diagrams/src/models-component.puml create mode 100644 docs/diagrams/src/sequence.puml diff --git a/docs/diagrams/src/models-class.puml b/docs/diagrams/src/models-class.puml new file mode 100644 index 0000000..9604212 --- /dev/null +++ b/docs/diagrams/src/models-class.puml @@ -0,0 +1,64 @@ +@startuml +!include https://raw.githubusercontent.com/joekolodz/puml-themes/main/themes/sierrahotas/puml-theme-sierrahotas.puml + +title + +SierraHOTAS +Class Diagram + +Models + +end title + +interface IHOTASBaseMap + +class HOTASCollection { + + <> KeystrokeDownSent + + <> KeystrokeUpSent + + <> MacroStarted + + <> MacroCancelled + + <> ButtonPressed + + <> AxisChanged + + <> ModeProfileChanged + + <> LostConnectionToDevice +} + +class HOTASDevice +class "ButtonMap\nCollection" as ButtonMap +class HOTASQueue { + read loop +} + +class Joystick { + (DirectInput) +} +class HOTASAxis +class HOTASButton +class "Forward Button Map" as ForwardButtonMap +class "Reverse Button Map" as ReverseButtonMap +class Segments +class ActionCatalogItem +class ButtonAction { + scan codes + flags + etc +} + +IHOTASBaseMap .right. ButtonMap + +HOTASCollection -- "0..*" HOTASDevice +HOTASDevice -- "0..*" ButtonMap +HOTASDevice -- "1" HOTASQueue +HOTASDevice -- "1" Joystick + +ButtonMap -- "0..*" HOTASAxis +ButtonMap -- "0..*" HOTASButton + +HOTASAxis -- "0..*" Segments +HOTASAxis -- "0..*" ForwardButtonMap +HOTASAxis -- "0..*" ReverseButtonMap + +HOTASButton -- ActionCatalogItem +ActionCatalogItem -- "0..*" ButtonAction + +@enduml diff --git a/docs/diagrams/src/models-component.puml b/docs/diagrams/src/models-component.puml new file mode 100644 index 0000000..afbceb3 --- /dev/null +++ b/docs/diagrams/src/models-component.puml @@ -0,0 +1,65 @@ +@startuml + +!theme bluegray + +skinparam linetype ortho +skinparam roundcorner 6 + +skinparam rectangle{ + bordercolor black +} + +skinparam collections{ + bordercolor black +} + +skinparam note{ + fontsize 9 + BackgroundColor $PRIMARY-$PRIMARY_LIGHT +} + +rectangle HOTASCollection +collections HOTASDevice +collections "ButtonMap\n(IHotasBaseMap)" as ButtonMap +rectangle "HOTASQueue\n(read loop)" as HOTASQueue +rectangle "Joystick\n(DirectInput)" as Joystick +collections HOTASAxis +collections "Button Map" as HOTASButton +collections "Reverse Button Map" as ReverseButtonMap +collections Segments + +note right of HOTASCollection +KeystrokeDownSent +KeystrokeUpSent +MacroStarted +MacroCancelled +ButtonPressed +AxisChanged +ModeProfileChanged +endnote + + +note right of HOTASDevice +KeystrokeDownSent +KeystrokeUpSent +MacroStarted +MacroCancelled +ButtonPressed +AxisChanged +ModeProfileSelected +ShiftReleased + +endnote + + +HOTASCollection --> HOTASDevice +HOTASDevice --> ButtonMap +HOTASDevice --> HOTASQueue +HOTASDevice --> Joystick +ButtonMap ..> HOTASAxis +ButtonMap .left.> HOTASButton +HOTASAxis --> HOTASButton +HOTASAxis --> ReverseButtonMap +HOTASAxis --> Segments + +@enduml \ No newline at end of file diff --git a/docs/diagrams/src/sequence.puml b/docs/diagrams/src/sequence.puml new file mode 100644 index 0000000..f22b62d --- /dev/null +++ b/docs/diagrams/src/sequence.puml @@ -0,0 +1,112 @@ +@startuml +!include https://raw.githubusercontent.com/joekolodz/puml-themes/main/themes/sierrahotas/puml-theme-sierrahotas.puml + +!$BLACK = "#000" + +!$TEXT_SECONDARY = $BLACK + +skinparam sequence { + BorderColor $OBJECT_BORDER + ' For some reason sequence title font color does not pick up from global + TitleFontColor $TEXT + BackgroundColor $OBJECT_BACKGROUND + StartColor $PRIMARY + EndColor $PRIMARY + '' + BoxBackgroundColor $BGCOLOR + BoxBorderColor $GRAY + BoxFontColor $DARK + '' + DelayFontColor $DARK + '' + LifeLineBorderColor $TEXT + LifeLineBorderThickness 2 + LifeLineBackgroundColor $OBJECT_BACKGROUND + '' + GroupBorderColor $OBJECT_BORDER + GroupFontColor $TEXT + GroupHeaderFontColor $TEXT_HEADER + GroupBackgroundColor $HEADER_BACKGROUND + GroupBodyBackgroundColor $OBJECT_BACKGROUND + GroupHeaderBackgroundColor $BACKGROUND + '' + DividerBackgroundColor $OBJECT_BACKGROUND + DividerBorderColor $OBJECT_BORDER + DividerBorderThickness 2 + DividerFontColor $GOLD + '' + ReferenceBackgroundColor $OBJECT_BACKGROUND + ReferenceBorderColor $OBJECT_BORDER + ReferenceFontColor $DARK_BLUEGRAY + ReferenceHeaderFontColor $TEXT_HEADER + '' + StereotypeFontColor $TEXT + + AttributeFontColor $TEXT + AttributeFontSize 50 + +} + + + +skinparam note{ + FontColor $TEXT_SECONDARY +} + + +title + +SierraHOTAS +Sequence Diagram + +Models + +end title + +participant Participant as Foo +actor Actor as Foo1 +boundary Boundary as Foo2 +control Control as Foo3 +entity Entity as Foo4 +database Database as Foo5 +collections Collections as Foo6 +queue Queue as Foo7 +Foo -> Foo1 : To actor +Foo -> Foo2 : To boundary +Foo -> Foo3 : To control +Foo -> Foo4 : To entity +Foo -> Foo5 : To database +Foo -> Foo6 : To collections +Foo -> Foo7: To queue + +participant "Famous Bob" as Bob << Generated >> +participant Alice << (C,$GOLD) Testable >> + +Alice -> Bob: Authentication Request + +alt successful case + + Bob -> Alice: Authentication Accepted +rnote left: this is a first note +else some kind of failure + + Bob -> Alice: Authentication Failure + group My own label + Alice -> Log : Log attack start + loop 1000 times + Alice -> Bob: DNS Attack + end + Alice -> Log : Log attack end + end + +else Another type of failure + + Bob -> Alice: Please repeat + +end + + + + +Bob->Alice: First message +@enduml \ No newline at end of file diff --git a/src/App.xaml b/src/App.xaml index 43a4dc9..519a497 100644 --- a/src/App.xaml +++ b/src/App.xaml @@ -20,7 +20,7 @@ - + diff --git a/src/Models/HOTASDevice.cs b/src/Models/HOTASDevice.cs index c281c7d..14f0215 100644 --- a/src/Models/HOTASDevice.cs +++ b/src/Models/HOTASDevice.cs @@ -251,6 +251,10 @@ private void RemoveQueueHandlers() _hotasQueue.LostConnectionToDevice -= OnLostConnectionToDevice; } + /// + /// Existing buttons in the profile will overlay buttons on the device. If a device has a button with matching profile, then we'll keep that button (otherwise we'd lose it if we just took profile buttons) + /// This allows a device to change without losing mappings (for instance when chaining a new Virpil device, or manually editing and removing buttons from the profile's JSON file) + /// public void OverlayAllProfilesToDevice() { var mergedModeProfiles = new Dictionary>(); @@ -267,6 +271,12 @@ public void OverlayAllProfilesToDevice() _hotasQueue.SetModeProfiles(ModeProfiles); } + /// + /// Examine each button in the Source map. If that button is also found in the Destination map, then use the Destination map's button, otherwise use the Source map's button. + /// + /// + /// + /// private ObservableCollection MergeMaps(ObservableCollection sourceMap, ObservableCollection destinationMap) { var merged = new ObservableCollection(); diff --git a/src/ViewModels/DeviceViewModel.cs b/src/ViewModels/DeviceViewModel.cs index bf7e1e9..ad0642e 100644 --- a/src/ViewModels/DeviceViewModel.cs +++ b/src/ViewModels/DeviceViewModel.cs @@ -6,7 +6,7 @@ using System.ComponentModel; using System.Linq; using System.Runtime.CompilerServices; -using System.Windows.Threading; +using SierraHOTAS.Controls; using SierraHOTAS.Factories; namespace SierraHOTAS.ViewModels