-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
203 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,6 +14,7 @@ | |
|
||
# Folders | ||
build/ | ||
out/ | ||
temp/ | ||
|
||
# VisualStudioCode # | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
## Component diagram | ||
![](diagrams/component-diagram.svg) | ||
|
||
--- | ||
Go to [Contents](Contents.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
@startuml | ||
|
||
package "USB Relay Module" as package_usb_relay_module { | ||
|
||
package "CLI Apps" as package_cli_apps { | ||
component getrelay #LightGreen | ||
component setrelay #LightGreen | ||
} | ||
|
||
package "GUI App" as package_gui_app { | ||
component relaybox #LightGreen | ||
} | ||
|
||
component libusbrelaymodule #LightGreen | ||
} | ||
|
||
package "Utils" as package_utils { | ||
component libcpputils #LightGreen | ||
component liblightargparser #LightGreen | ||
component logger #LightGreen | ||
component jsoncpp | ||
|
||
libcpputils -[hidden]d-> liblightargparser | ||
liblightargparser -[hidden]d-> logger | ||
logger -[hidden]d-> jsoncpp | ||
} | ||
|
||
package "hidapi" as package_hidapi { | ||
component "libhidapi-hidraw" as libhidapi_hidraw | ||
component hidapi | ||
} | ||
|
||
|
||
package "Windows OS" { | ||
component hid | ||
} | ||
|
||
package "Linux OS" { | ||
component libudev | ||
} | ||
|
||
node "USB Relay" as relay { | ||
port channel1 | ||
port channel2 | ||
port channelN | ||
} | ||
|
||
interface USB | ||
|
||
package_usb_relay_module --> package_utils : uses | ||
|
||
getrelay -d-> libusbrelaymodule : uses | ||
|
||
setrelay -d-> libusbrelaymodule : uses | ||
relaybox -d-> libusbrelaymodule : uses | ||
|
||
libusbrelaymodule -d-> libhidapi_hidraw : uses\n if Linux OS | ||
libusbrelaymodule -d-> hidapi : uses\n if Windows OS | ||
|
||
hidapi -d-> hid : uses | ||
|
||
libhidapi_hidraw -d-> libudev : uses | ||
|
||
hid -d-( USB | ||
libudev -d-( USB | ||
|
||
relay -u-( USB | ||
|
||
legend left | ||
Legend | ||
| Symbol | Meaning | | ||
|<#LightGreen>| nkh-lab components | | ||
endlegend | ||
|
||
@enduml |
Oops, something went wrong.