dkelly/pynkode
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor docs

Browse Source
This commit is contained in:
Donovan
2025-03-24 09:52:52 -05:00
parent 538dc6b17c
commit 0f7bda0942
6 changed files with 21 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/enrollment_diagram.md
View File

@@ -12,26 +12,26 @@ sequenceDiagram
Server->>Server: Create Signup Session
Note over User,Server: Set nKode
Server-->>-Client: signup_session_id, set_keypad, icons
Note left of Server: signup_session_id:<br/>e029138e-fb64-49ea-a6bc-b6b5affbf263
Note left of Server: set_keypad:<br/>Key 0: [18 7 20 22 23]<br/>Key 1: [12 13 8 28 29]<br/>Key 2: [24 25 26 16 5]<br/>Key 3: [ 6 19 2 10 11]<br/>Key 4: [ 0 1 14 4 17]<br/>
Note left of Server: signup_session_id:<br/>d7e50a75-d3ff-482a-b0e7-ce99c3838c1a
Note left of Server: set_keypad:<br/>Key 0: [12 13 20 21 16]<br/>Key 1: [ 6 1 14 9 4]<br/>Key 2: [ 0 7 26 15 28]<br/>Key 3: [24 19 2 27 10]<br/>Key 4: [18 25 8 3 22]<br/>
Note left of Server: Icons:<br/>[😀,😂,🥳,😍,🤓<br/>😎,🥺,😡,😱,🤯<br/>🥰,😴,🤔,🙃,😇<br/>🤖,👽,👾,🐱,🐶<br/>🦁,🐻,🐸,🐙,🦄<br/>🌟,⚡,🔥,🍕,🎉]
Client->>Client: Order Icons by keypad
Client->>User: Display Keypad
Note left of Client: Key 0: ['🐱' '😡' '🦁' '🐸' '🐙']<br/>Key 1: ['🤔' '🙃' '😱' '🍕' '🎉']<br/>Key 2: ['🦄' '🌟' '⚡' '👽' '😎']<br/>Key 3: ['🥺' '🐶' '🥳' '🥰' '😴']<br/>Key 4: ['😀' '😂' '😇' '🤓' '👾']<br/>
Note left of User: User icons: ['🐱' '🥳' '🐶' '⚡']
User->>Client: Set Key Selection: [0, 3, 3, 2]
Client->>+Server: Set nKode:<br/>e029138e-fb64-49ea-a6bc-b6b5affbf263<br/>[0, 3, 3, 2]
Note left of Client: Key 0: ['🤔' '🙃' '🦁' '🐻' '👽']<br/>Key 1: ['🥺' '😂' '😇' '🤯' '🤓']<br/>Key 2: ['😀' '😡' '⚡' '🤖' '🍕']<br/>Key 3: ['🦄' '🐶' '🥳' '🔥' '🥰']<br/>Key 4: ['🐱' '🌟' '😱' '😍' '🐸']<br/>
Note left of User: User icons: ['🤓' '🐶' '🦄' '👽']
User->>Client: Set Key Selection: [1, 3, 3, 0]
Client->>+Server: Set nKode:<br/>d7e50a75-d3ff-482a-b0e7-ce99c3838c1a<br/>[1, 3, 3, 0]
Server->>Server: Disperse Set Keypad
Note over User,Server: Confirm nKode
Server-->>-Client: signup_session_id, confirm_keypad, icons
Note left of Server: signup_session_id:<br/>e029138e-fb64-49ea-a6bc-b6b5affbf263
Note left of Server: confirm_keypad:<br/>Key 0: [ 6 7 8 16 17]<br/>Key 1: [ 0 13 2 22 5]<br/>Key 2: [24 19 14 28 23]<br/>Key 3: [18 1 26 10 29]<br/>Key 4: [12 25 20 4 11]<br/>
Note left of Server: signup_session_id:<br/>d7e50a75-d3ff-482a-b0e7-ce99c3838c1a
Note left of Server: confirm_keypad:<br/>Key 0: [ 6 13 8 15 10]<br/>Key 1: [24 7 14 3 16]<br/>Key 2: [12 25 2 9 28]<br/>Key 3: [ 0 1 20 27 22]<br/>Key 4: [18 19 26 21 4]<br/>
Client->>Client: Order Icons by keypad
Client->>User: Display Keypad
Note left of Client: Key 0: ['🥺' '😡' '😱' '👽' '👾']<br/>Key 1: ['😀' '🙃' '🥳' '🐸' '😎']<br/>Key 2: ['🦄' '🐶' '😇' '🍕' '🐙']<br/>Key 3: ['🐱' '😂' '⚡' '🥰' '🎉']<br/>Key 4: ['🤔' '🌟' '🦁' '🤓' '😴']<br/>
Note left of User: User icons: ['🐱' '🥳' '🐶' '⚡']
User->>Client: Key Selection: [3, 1, 2, 3]
Client->>+Server: Confirm nKode:<br/>e029138e-fb64-49ea-a6bc-b6b5affbf263<br/>[3, 1, 2, 3]
Note left of Client: Key 0: ['🥺' '🙃' '😱' '🤖' '🥰']<br/>Key 1: ['🦄' '😡' '😇' '😍' '👽']<br/>Key 2: ['🤔' '🌟' '🥳' '🤯' '🍕']<br/>Key 3: ['😀' '😂' '🦁' '🔥' '🐸']<br/>Key 4: ['🐱' '🐶' '⚡' '🐻' '🤓']<br/>
Note left of User: User icons: ['🤓' '🐶' '🦄' '👽']
User->>Client: Key Selection: [4, 4, 1, 1]
Client->>+Server: Confirm nKode:<br/>d7e50a75-d3ff-482a-b0e7-ce99c3838c1a<br/>[4, 4, 1, 1]
Server->>Server: Create User
Server-->>-Client: Success
```