diff --git a/index.rst b/index.rst index 8546bbb32e1b68b9e376d15c513d987668bca979..da1ca3d01d40582b9d2491cd5efd6d1316a5b806 100644 --- a/index.rst +++ b/index.rst @@ -319,6 +319,7 @@ developers. Some developers choose to host documentation for their :ref:`project :caption: Projects /projects/simppru/index + /projects/bb-config/index /boards/beagleconnect/index Books diff --git a/projects/bb-config/build.rst b/projects/bb-config/build.rst new file mode 100644 index 0000000000000000000000000000000000000000..d7f83f4a09d7980e5522deacf3ac8b8f39a76f98 --- /dev/null +++ b/projects/bb-config/build.rst @@ -0,0 +1,29 @@ +Build from Source +################### + +Dependencies +************** + +- g++ +- cmake +- glib-2.0 +- libnm + +Build +****** + +.. code:: bash + + git clone https://git.beagleboard.org/gsoc/bb-config + cd bb-config + mkdir build + cd build + cmake .. + make -j$(nproc) + +Install +******** + +.. code:: bash + + sudo make install diff --git a/projects/bb-config/detail.rst b/projects/bb-config/detail.rst new file mode 100644 index 0000000000000000000000000000000000000000..ff983d8d3f656f631ff3ce25a9da6c6c90fdc47a --- /dev/null +++ b/projects/bb-config/detail.rst @@ -0,0 +1,28 @@ +.. _bb_config_detail: + +BB-Config Detail +################# +Configure your beagle devices easily. + +`Github <https://git.beagleboard.org/gsoc/bb-config>`_ + +.. image:: images/bb-config.png + :alt: BB-Config Logo + + +What is BB-Config +****************** + +BB-Config is a software that makes the most common low-level +configuration changes in beagle devices easily and provides a +terminal UI. + +BB-Config is using `FTXUI <https://github.com/ArthurSonzogni/FTXUI>`_ (C++ Functional Terminal User Interface) +which have simple and elegant UI looking. + +Look Like +========== + +.. image:: images/about.png + :align: center + :alt: bb-config about \ No newline at end of file diff --git a/projects/bb-config/features.rst b/projects/bb-config/features.rst new file mode 100644 index 0000000000000000000000000000000000000000..4786467aa6a215eccceadab4465c741170ed8d22 --- /dev/null +++ b/projects/bb-config/features.rst @@ -0,0 +1,191 @@ +Features +######### + +BB-Config v1.x +*************** + +PRU Enable/Disable +=================== +- Enable/Disable PRU + +.. image:: images/pru.png + :align: center + :alt: pru + + +GPIO +===== +- Turn On/Off gpio + +GPIO Menu +---------- + +.. image:: images/gpio.png + :align: center + :alt: gpio menu + + +GPIO Setting +------------- + +.. image:: images/gpio2.png + :align: center + :alt: gpio setting + + +EMMC and MicroSD Stats +======================= +- Storage stats & grow partition + +.. image:: images/emmc.png + :align: center + :alt: emmc + + +LEDs +===== +- Config board build in LEDs + +.. image:: images/leds.png + :align: center + :alt: leds + + +Password +========= +- Change users password + +.. image:: images/password.png + :align: center + :alt: password + + +SSH +==== +- Enable/Disable SSH + +.. image:: images/ssh.png + :align: center + :alt: ssh + + +WiFi +===== +- Connect to Wi-Fi + +.. image:: images/wifi.png + :align: center + :alt: WiFi + + +Internet Sharing and Client Config +=================================== + +.. image:: images/ics.png + :align: center + :alt: ics + + +- Note: You'll have to configure your host Following is an example script: + +.. code:: bash + echo 1 > /proc/sys/net/ipv4/ip_forward + iptables --table nat --append POSTROUTING --out-interface wlp4s0 -j MASQUERADE + iptables --append FORWARD --in-interface wlp4s0 -j ACCEPT + +About +====== + +.. image:: images/about.png + :align: center + :alt: about + + +BB-Config v2.x +*************** + +ADC (Graph) +============ +- Plot graph for Analogue pin + +.. image:: images/adc2.png + :align: center + :alt: adc page + + +.. image:: images/adc.png + :align: center + :alt: adc graph + + +DAC (PWM) +========== +- Generate PWM waveform + +.. image:: images/pwm.png + :align: center + :alt: pwm + + +uEnv +===== +- Enable/Disable boot configuration + +.. image:: images/uEnv.png + :align: center + :alt: uEnv + + +services +========= +- Enable/Disable services startup at boot + +.. image:: images/service.png + :align: center + :alt: service + + +PINMUX +======= +- Display PIN I/O detail +- Config PINMUX + +Hardware Display +----------------- +.. image:: images/pinmux.png + :align: center + :alt: pinmux hardware + + +Pin Table Refernce +-------------------- +.. image:: images/pinmux2.png + :align: center + :alt: pinmux table references + + +Pin Config +-------------- +.. image:: images/pinmux3.png + :align: center + :alt: pinmux config + + +Overlay (dts) +============== +- Enable/Disable Device Tree Overlay in Boot option +- Select dtbo file and automate update in uEnv.txt + +.. image:: images/overlay.png + :align: center + :alt: overlay + + +WiFi (D-Bus) +============= +- Connect to WiFi with wpa_supplicant +- Support for Debian 11 + +.. image:: images/wifi-dbus.png + :align: center + :alt: WiFi D-Bus \ No newline at end of file diff --git a/projects/bb-config/gif/ADC.gif b/projects/bb-config/gif/ADC.gif new file mode 100644 index 0000000000000000000000000000000000000000..547f6646684fb5c854d2b156b8558e82cdbf0e86 Binary files /dev/null and b/projects/bb-config/gif/ADC.gif differ diff --git a/projects/bb-config/gif/UI.gif b/projects/bb-config/gif/UI.gif new file mode 100644 index 0000000000000000000000000000000000000000..2929782380ec4ef9f438757729d9b1995ec97b2c Binary files /dev/null and b/projects/bb-config/gif/UI.gif differ diff --git a/projects/bb-config/gif/emmc.gif b/projects/bb-config/gif/emmc.gif new file mode 100644 index 0000000000000000000000000000000000000000..24684ae3634d49226906427cec841781f9661e43 Binary files /dev/null and b/projects/bb-config/gif/emmc.gif differ diff --git a/projects/bb-config/gif/emmc2.gif b/projects/bb-config/gif/emmc2.gif new file mode 100644 index 0000000000000000000000000000000000000000..5aebba9b6ec374b4aa96f432dbadff86c1d36705 Binary files /dev/null and b/projects/bb-config/gif/emmc2.gif differ diff --git a/projects/bb-config/gif/ics.gif b/projects/bb-config/gif/ics.gif new file mode 100644 index 0000000000000000000000000000000000000000..789e3a2f8d6d29a1fb4e05fe33b344f7e00199f6 Binary files /dev/null and b/projects/bb-config/gif/ics.gif differ diff --git a/projects/bb-config/gif/pinmux.gif b/projects/bb-config/gif/pinmux.gif new file mode 100644 index 0000000000000000000000000000000000000000..ed59687498f477cc524b54557c1e4c4c8ae70fe7 Binary files /dev/null and b/projects/bb-config/gif/pinmux.gif differ diff --git a/projects/bb-config/gif/services.gif b/projects/bb-config/gif/services.gif new file mode 100644 index 0000000000000000000000000000000000000000..1b4ebb437e478580b8625bc5cbe9c4463ac74098 Binary files /dev/null and b/projects/bb-config/gif/services.gif differ diff --git a/projects/bb-config/gif/uEnv.gif b/projects/bb-config/gif/uEnv.gif new file mode 100644 index 0000000000000000000000000000000000000000..412614e50d72b755268807eddb31bb60fbfd1abc Binary files /dev/null and b/projects/bb-config/gif/uEnv.gif differ diff --git a/projects/bb-config/gif/wifi.gif b/projects/bb-config/gif/wifi.gif new file mode 100644 index 0000000000000000000000000000000000000000..71a11ca96b66801a2482b1d34319ae95f603c1b5 Binary files /dev/null and b/projects/bb-config/gif/wifi.gif differ diff --git a/projects/bb-config/images/about.png b/projects/bb-config/images/about.png new file mode 100644 index 0000000000000000000000000000000000000000..05432d914c595b02e021b673cc21c40ef7a76c9e Binary files /dev/null and b/projects/bb-config/images/about.png differ diff --git a/projects/bb-config/images/adc.png b/projects/bb-config/images/adc.png new file mode 100644 index 0000000000000000000000000000000000000000..efde6b6f1cfd6ab1b993ce61b784d0767f355f1f Binary files /dev/null and b/projects/bb-config/images/adc.png differ diff --git a/projects/bb-config/images/adc2.png b/projects/bb-config/images/adc2.png new file mode 100644 index 0000000000000000000000000000000000000000..21b52a3bad7412493ad5bc7f32554f1d5617aa8c Binary files /dev/null and b/projects/bb-config/images/adc2.png differ diff --git a/projects/bb-config/images/bb-config.png b/projects/bb-config/images/bb-config.png new file mode 100644 index 0000000000000000000000000000000000000000..da2531d598f57776194a1e8c37d7dca3f9d7757c Binary files /dev/null and b/projects/bb-config/images/bb-config.png differ diff --git a/projects/bb-config/images/emmc.png b/projects/bb-config/images/emmc.png new file mode 100644 index 0000000000000000000000000000000000000000..c68f54048faa4eb2d4d47ddbebef5da8f1747430 Binary files /dev/null and b/projects/bb-config/images/emmc.png differ diff --git a/projects/bb-config/images/gpio.png b/projects/bb-config/images/gpio.png new file mode 100644 index 0000000000000000000000000000000000000000..83be126ddbac5236945582767e5ed7d29f84fef9 Binary files /dev/null and b/projects/bb-config/images/gpio.png differ diff --git a/projects/bb-config/images/gpio2.png b/projects/bb-config/images/gpio2.png new file mode 100644 index 0000000000000000000000000000000000000000..1697d3ce92c1b53abfc283bf3eb2f60775c0f5ee Binary files /dev/null and b/projects/bb-config/images/gpio2.png differ diff --git a/projects/bb-config/images/ics.png b/projects/bb-config/images/ics.png new file mode 100644 index 0000000000000000000000000000000000000000..84a76888970adc6cdc819dfdc027bc7d1624b8b2 Binary files /dev/null and b/projects/bb-config/images/ics.png differ diff --git a/projects/bb-config/images/leds.png b/projects/bb-config/images/leds.png new file mode 100644 index 0000000000000000000000000000000000000000..c69a7db13428cf6e5cd29a7eec9a1096fb4d0f4a Binary files /dev/null and b/projects/bb-config/images/leds.png differ diff --git a/projects/bb-config/images/logo.png b/projects/bb-config/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..a54161b20e9083e0663561c6cb03cb88b9ec81fd Binary files /dev/null and b/projects/bb-config/images/logo.png differ diff --git a/projects/bb-config/images/overlay.png b/projects/bb-config/images/overlay.png new file mode 100644 index 0000000000000000000000000000000000000000..51f420631647be097e10967dc1c8dddf74e4de37 Binary files /dev/null and b/projects/bb-config/images/overlay.png differ diff --git a/projects/bb-config/images/password.png b/projects/bb-config/images/password.png new file mode 100644 index 0000000000000000000000000000000000000000..b894f6416c44a5b1106fdc26abcec7374aec5da2 Binary files /dev/null and b/projects/bb-config/images/password.png differ diff --git a/projects/bb-config/images/pinmux.png b/projects/bb-config/images/pinmux.png new file mode 100644 index 0000000000000000000000000000000000000000..bee7ac0a427023b6a7d94c3ab3a93bc05d6f6622 Binary files /dev/null and b/projects/bb-config/images/pinmux.png differ diff --git a/projects/bb-config/images/pinmux2.png b/projects/bb-config/images/pinmux2.png new file mode 100644 index 0000000000000000000000000000000000000000..a8950202279b1f89192064294b47a5183e24790f Binary files /dev/null and b/projects/bb-config/images/pinmux2.png differ diff --git a/projects/bb-config/images/pinmux3.png b/projects/bb-config/images/pinmux3.png new file mode 100644 index 0000000000000000000000000000000000000000..e4f7d4a4da1a5d962093fc61e37ff0c07c9dc0aa Binary files /dev/null and b/projects/bb-config/images/pinmux3.png differ diff --git a/projects/bb-config/images/pru.png b/projects/bb-config/images/pru.png new file mode 100644 index 0000000000000000000000000000000000000000..f648f4eb47ed8a908b73d6cb83bafda1a68c97f8 Binary files /dev/null and b/projects/bb-config/images/pru.png differ diff --git a/projects/bb-config/images/pwm.png b/projects/bb-config/images/pwm.png new file mode 100644 index 0000000000000000000000000000000000000000..2d9e61cab63705bd63e4bbfc707f9803d0634f41 Binary files /dev/null and b/projects/bb-config/images/pwm.png differ diff --git a/projects/bb-config/images/service.png b/projects/bb-config/images/service.png new file mode 100644 index 0000000000000000000000000000000000000000..0262c8556589622a14d7f8ab5b33c8bd4122c0d0 Binary files /dev/null and b/projects/bb-config/images/service.png differ diff --git a/projects/bb-config/images/ssh.png b/projects/bb-config/images/ssh.png new file mode 100644 index 0000000000000000000000000000000000000000..cbf792fe0cb3d2c7d0dbb9c84ee3022a849786b8 Binary files /dev/null and b/projects/bb-config/images/ssh.png differ diff --git a/projects/bb-config/images/uEnv.png b/projects/bb-config/images/uEnv.png new file mode 100644 index 0000000000000000000000000000000000000000..da06f2500c6793e8695c4ed9e461cb3806b9920b Binary files /dev/null and b/projects/bb-config/images/uEnv.png differ diff --git a/projects/bb-config/images/wifi-dbus.png b/projects/bb-config/images/wifi-dbus.png new file mode 100644 index 0000000000000000000000000000000000000000..02771aa306fe87cf0ae4861c82adef69662462c3 Binary files /dev/null and b/projects/bb-config/images/wifi-dbus.png differ diff --git a/projects/bb-config/images/wifi.png b/projects/bb-config/images/wifi.png new file mode 100644 index 0000000000000000000000000000000000000000..2eaacb90c131c1281b65e09e6ad0de9bea1fc9ab Binary files /dev/null and b/projects/bb-config/images/wifi.png differ diff --git a/projects/bb-config/index.rst b/projects/bb-config/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..772366ba801c46c948fa0e9393775f244f03f6e2 --- /dev/null +++ b/projects/bb-config/index.rst @@ -0,0 +1,12 @@ +.. _bb_config_home: + +BB-Config +######## + +.. toctree:: + :maxdepth: 1 + + detail.rst + build.rst + features.rst + version.rst diff --git a/projects/bb-config/version.rst b/projects/bb-config/version.rst new file mode 100644 index 0000000000000000000000000000000000000000..72e607221ff9e82b1d3bc1436b1d3c930975202a --- /dev/null +++ b/projects/bb-config/version.rst @@ -0,0 +1,23 @@ +Version +####### + +GSOC@21 BB-Config v1.x +*********************** +- Name: Shreyas Atre +- Mentors: Arthur Sonzogni, Abhishek Kumar, Deepak Khatri. +- Organization: BeagleBoard.org +- Code: https://github.com/SAtacker/beagle-config +- Project Page: https://summerofcode.withgoogle.com/projects/#6718016412188672 +- Progress Log: https://satacker.github.io/gsoc-log/ +- Kanban: https://github.com/SAtacker/beagle-config/projects/1 +- Initial Video: https://youtu.be/vFUWCzqE6xI + +GSOC@22 BB-Config v2.x +*********************** +- Name: Seak Jian De +- Mentors: Shreyas Atre, Vedant Paranjape, Vaishnav Achath. +- Organization: BeagleBoard.org +- Code: https://git.beagleboard.org/gsoc/bb-config +- Project Page: https://summerofcode.withgoogle.com/programs/2022/projects/2DbiYPlY +- Progress Log: https://forum.beagleboard.org/t/weekly-progress-report-bb-config-improvements-gpio-benchmark/32357/2 +- Initial Video: https://youtu.be/V_Euk5uWY1o \ No newline at end of file diff --git a/projects/index.rst b/projects/index.rst index 4e5831752be7493d393f92f4f930548d57c3b057..4e6376466a62d78264f560e2ea0f780851ce539e 100644 --- a/projects/index.rst +++ b/projects/index.rst @@ -9,4 +9,5 @@ This is a collection of reasonably well-supported projects useful to Beagle deve :maxdepth: 1 /projects/simppru/index.rst + /projects/bb-config/index.rst /boards/beagleconnect/index.rst