diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..976d331 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# How to Contribute + +We'd love to accept your patches and contributions to this project. There are +just a few small guidelines you need to follow. + +## Version of C++ +This project is based on the C++17 standard and compiles as-is on most platforms +using either clang or g++. Do not use C++21 or C++23 features for now. Some core +libraries used in this project do not support C++21 or C++23 yet. + +## Variable Naming +Naming of pretty much anything uses Pascal naming. Longer explicit names using casing. +Member variable naming adds a `_` at the end of the vars. Try to +keep this standard going. Sometimes you must override a base class function and then of course +you need to follow the base class. + +## This is a cmake project +This is a cmake project, and you need to adhere to the cmake rules. If you need +to add a package to the CMakeList, you need to ensure that the package is available +on all required platforms and compiles. Remember that this project runs on Linux, OS X, +and the Raspberry PI. + +## Licensed packages +When adding a package, you must also state the licensing for the package. MIT, BSD, Apache licenses +are acceptable. No commercial licenses are allowed. + +## clang formatting +Please format your code using the included `.clang-format` file included in the project. + +```bash +clang-format -i --style=/.clang-format myfile.cpp +``` + +## Pull Requests +All submissions, including submissions by project members, require review. We +accept GitHub pull requests. Please create a branch with the Jira name for addressing the issue you are fixing or the +feature you are implementing. +Create a pull-request from the branch into master. diff --git a/README.md b/README.md index 3385f37..5abe07d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +

+ # OpenWiFi Provisioning ## OpenAPI diff --git a/images/device_types/cig_wf160d.png b/images/device_types/cig_wf160d.png new file mode 100644 index 0000000..bc5fce8 Binary files /dev/null and b/images/device_types/cig_wf160d.png differ diff --git a/images/device_types/cig_wf188.png b/images/device_types/cig_wf188.png new file mode 100644 index 0000000..066a256 Binary files /dev/null and b/images/device_types/cig_wf188.png differ diff --git a/images/device_types/cig_wf188n.png b/images/device_types/cig_wf188n.png new file mode 100644 index 0000000..066a256 Binary files /dev/null and b/images/device_types/cig_wf188n.png differ diff --git a/images/device_types/cig_wf194c.png b/images/device_types/cig_wf194c.png new file mode 100644 index 0000000..97a0dea Binary files /dev/null and b/images/device_types/cig_wf194c.png differ diff --git a/images/device_types/cig_wf194c4.png b/images/device_types/cig_wf194c4.png new file mode 100644 index 0000000..97a0dea Binary files /dev/null and b/images/device_types/cig_wf194c4.png differ diff --git a/images/device_types/cig_wf808.png b/images/device_types/cig_wf808.png new file mode 100644 index 0000000..b1aee0d Binary files /dev/null and b/images/device_types/cig_wf808.png differ diff --git a/images/device_types/cig_wf809.png b/images/device_types/cig_wf809.png new file mode 100644 index 0000000..478f2fd Binary files /dev/null and b/images/device_types/cig_wf809.png differ diff --git a/images/device_types/edgecore_eap101.png b/images/device_types/edgecore_eap101.png new file mode 100644 index 0000000..d5a20b4 Binary files /dev/null and b/images/device_types/edgecore_eap101.png differ diff --git a/images/device_types/edgecore_eap102.png b/images/device_types/edgecore_eap102.png new file mode 100644 index 0000000..78f1381 Binary files /dev/null and b/images/device_types/edgecore_eap102.png differ diff --git a/images/device_types/edgecore_ecs4100-12ph.png b/images/device_types/edgecore_ecs4100-12ph.png new file mode 100644 index 0000000..34dea96 Binary files /dev/null and b/images/device_types/edgecore_ecs4100-12ph.png differ diff --git a/images/device_types/edgecore_ecw5211.png b/images/device_types/edgecore_ecw5211.png new file mode 100644 index 0000000..d0b90f6 Binary files /dev/null and b/images/device_types/edgecore_ecw5211.png differ diff --git a/images/device_types/edgecore_ecw5410.png b/images/device_types/edgecore_ecw5410.png new file mode 100644 index 0000000..aa2ef47 Binary files /dev/null and b/images/device_types/edgecore_ecw5410.png differ diff --git a/images/device_types/edgecore_oap100.png b/images/device_types/edgecore_oap100.png new file mode 100644 index 0000000..7e75c81 Binary files /dev/null and b/images/device_types/edgecore_oap100.png differ diff --git a/images/device_types/edgecore_spw2ac1200-lan-poe.png b/images/device_types/edgecore_spw2ac1200-lan-poe.png new file mode 100644 index 0000000..324e810 Binary files /dev/null and b/images/device_types/edgecore_spw2ac1200-lan-poe.png differ diff --git a/images/device_types/edgecore_spw2ac1200.png b/images/device_types/edgecore_spw2ac1200.png new file mode 100644 index 0000000..324e810 Binary files /dev/null and b/images/device_types/edgecore_spw2ac1200.png differ diff --git a/images/device_types/edgecore_ssw2ac2600.png b/images/device_types/edgecore_ssw2ac2600.png new file mode 100644 index 0000000..2d12201 Binary files /dev/null and b/images/device_types/edgecore_ssw2ac2600.png differ diff --git a/images/device_types/hfcl_ion4.png b/images/device_types/hfcl_ion4.png new file mode 100644 index 0000000..b3d530a Binary files /dev/null and b/images/device_types/hfcl_ion4.png differ diff --git a/images/device_types/hfcl_ion4.yml.png b/images/device_types/hfcl_ion4.yml.png new file mode 100644 index 0000000..b3d530a Binary files /dev/null and b/images/device_types/hfcl_ion4.yml.png differ diff --git a/images/device_types/indio_um-305ac.png b/images/device_types/indio_um-305ac.png new file mode 100644 index 0000000..fb70a7d Binary files /dev/null and b/images/device_types/indio_um-305ac.png differ diff --git a/images/device_types/linksys_e8450-ubi.png b/images/device_types/linksys_e8450-ubi.png new file mode 100644 index 0000000..590345b Binary files /dev/null and b/images/device_types/linksys_e8450-ubi.png differ diff --git a/images/device_types/linksys_ea6350-v4.png b/images/device_types/linksys_ea6350-v4.png new file mode 100644 index 0000000..d65873e Binary files /dev/null and b/images/device_types/linksys_ea6350-v4.png differ diff --git a/images/device_types/linksys_ea6350.png b/images/device_types/linksys_ea6350.png new file mode 100644 index 0000000..d65873e Binary files /dev/null and b/images/device_types/linksys_ea6350.png differ diff --git a/images/device_types/linksys_ea8300.png b/images/device_types/linksys_ea8300.png new file mode 100644 index 0000000..e651d70 Binary files /dev/null and b/images/device_types/linksys_ea8300.png differ diff --git a/images/device_types/tp-link_ec420-g1.png b/images/device_types/tp-link_ec420-g1.png new file mode 100644 index 0000000..8459e15 Binary files /dev/null and b/images/device_types/tp-link_ec420-g1.png differ diff --git a/images/device_types/tplink_ec420.png b/images/device_types/tplink_ec420.png new file mode 100644 index 0000000..8459e15 Binary files /dev/null and b/images/device_types/tplink_ec420.png differ diff --git a/images/device_types/tplink_ex227.png b/images/device_types/tplink_ex227.png new file mode 100644 index 0000000..f293c2b Binary files /dev/null and b/images/device_types/tplink_ex227.png differ diff --git a/images/device_types/tplink_ex228.png b/images/device_types/tplink_ex228.png new file mode 100644 index 0000000..f293c2b Binary files /dev/null and b/images/device_types/tplink_ex228.png differ diff --git a/images/device_types/tplink_ex447.png b/images/device_types/tplink_ex447.png new file mode 100644 index 0000000..f293c2b Binary files /dev/null and b/images/device_types/tplink_ex447.png differ diff --git a/images/device_types/wallys_dr40x9.png b/images/device_types/wallys_dr40x9.png new file mode 100644 index 0000000..a096300 Binary files /dev/null and b/images/device_types/wallys_dr40x9.png differ diff --git a/images/device_types/wallys_dr6018.png b/images/device_types/wallys_dr6018.png new file mode 100644 index 0000000..292f67d Binary files /dev/null and b/images/device_types/wallys_dr6018.png differ diff --git a/images/device_types/wallys_dr6018_v4.png b/images/device_types/wallys_dr6018_v4.png new file mode 100644 index 0000000..292f67d Binary files /dev/null and b/images/device_types/wallys_dr6018_v4.png differ diff --git a/images/project/logo.png b/images/project/logo.png new file mode 100644 index 0000000..c64a547 Binary files /dev/null and b/images/project/logo.png differ diff --git a/images/project/logo.svg b/images/project/logo.svg new file mode 100644 index 0000000..89e527c --- /dev/null +++ b/images/project/logo.svg @@ -0,0 +1,165 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +