Home

Welcome to the beagle-config wiki!

    ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⠴⠒⠛⠉⠉⠉⠉⠓⠲⢤⣀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣠⠴⢯⣅⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠳⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⡾⠉⠀⠀⠀⠀⠱⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⢧⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡞⠀⠀⠀⠀⠀⠀⠀⢳⠀⢀⡠⢤⣄⡀⠀⠀⠀⠠⣎⣹⣧⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣾⠃⠀⠀⠀⠀⠀⠀⠀⠘⡇⠸⣷⣾⣿⠇⠀⠀⠀⠀⠈⠉⠙⠦⣄⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⢹⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠉⠑⠲⢄⡀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⠇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⣇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣤⠶⠛⠒⣄⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣸⠏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠸⡆⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢠⣿⣤⣤⣴⣾⣿⡇⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⢰⡏⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢻⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠻⣿⣿⣿⣿⠟⡇⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠁⢀⣼⠇⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⣷⡀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣸⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣀⣤⡴⠛⣟⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⣷⣄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡴⠃⠀⠀⠀⠀⠀⢀⣤⣤⣤⣶⣶⣾⣿⣿⡋⠉⠀⠀⢸⡆⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣀⠙⠿⢶⣤⣤⣀⣀⣀⣠⡤⠖⠋⠀⠀⠀⠀⠀⠀⠀⠀⠉⠛⠛⠿⠿⢿⣿⣿⢷⣄⠀⣀⡼⠁⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⠈⢱⠀⠀⢠⡟⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠁⠀⠐⠒⠒⠂⠈⢯⠉⠉⠀⠈⠉⠛⠉⠁⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣿⡀⠈⣇⠀⣼⠃⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠸⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠸⣷⡀⠘⢆⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠹⣷⡀⠘⢿⠀⠀⢸⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢸⡇⠀⠀⣷⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠙⣷⡀⠀⠀⠀⢸⡇⠀⠀⠀⡄⠀⠀⠀⠀⠀⣀⠀⠀⠀⠸⡇⠀⠀⡟⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠘⢳⣄⠀⠀⢸⡇⠀⠀⠀⣿⠀⠀⠀⠀⠀⣿⠀⠀⠀⠀⡇⠀⠀⡇⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢻⡇⠀⢸⠀⠀⠀⠀⣿⠀⠀⠀⠀⠀⡇⠀⠀⠀⠀⡇⠀⢸⠁⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣠⠾⠛⠀⢸⠀⠀⠀⠀⢹⠀⠀⠀⠀⠀⡇⠀⠀⠀⠀⣧⠀⠛⠦⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀
  ⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⣼⠇⠀⠀⢀⡿⠀⠀⠀⠀⢸⠀⠀⠀⠀⢰⡇⠀⠀⠀⠀⢻⡀⠀⠀⠈⡆⠀⠀⠀⠀⠀⠀⠀⠀⠀
              ⠀⢿⣆⡀⠀⡾⠁⠀⠀⠀⠀⢸⡟⠛⠛⠛⣿⡁⠀⠀⠀⠀⠀⢣⠀⢀⣠⠇        ⠀
              ⠀⠀⠙⠛⣿⣇⣀⠀⣀⣀⣠⡾⠃⠀⠀⠀⠻⣷⣄⣀⣀⠀⣀⣸⡟⠛⠉⠀        ⠀
               ⠀⠀⠀⠉⠛⠻⠿⠛⠛⠉⠀⠀⠀⠀⠀⠀⠈⠙⠛⠻⠿⠛⠋⠀⠀          ⠀
  _                      _                             __ _       
 | |__   ___  __ _  __ _| | ___        ___ ___  _ __  / _(_) __ _ 
 | '_ \ / _ \/ _` |/ _` | |/ _ \_____ / __/ _ \| '_ \| |_| |/ _` |
 | |_) |  __/ (_| | (_| | |  __/_____| (_| (_) | | | |  _| | (_| |
 |_.__/ \___|\__,_|\__, |_|\___|      \___\___/|_| |_|_| |_|\__, |
                   |___/                                    |___/

This is the Google Summer of Code 2021 project under beagleboard.org aimed at achieving:

• The functionality to make the most common low-level configuration changes in beagle devices easily and providing a terminal UI

TOC

• Project Details
• Examples
• Idea & benefit
  • Ideology
  • Benefit
• Conclusion
• Known Issues

Project Details

• 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

Implementation Overview

• The main philosophy was to make it as generic as possible.
• XDG specification gives it all for the location of the config file
• The components are pluggable meaning that additional configuration adding takes minimum changes.
• Unlike scripts it is considerably faster incase of areas like config-pin
• Because it uses ioctl calls from userspace to add routes to the routing table it is much faster and gives results as expected rather than having to use scripts.
• The overhead of FTXUI is not measured by me but can be "assumed" lightweight (or similar to other libs like ncurses).
• FTXUI is the only external dependency. Others like connman are assumed to be present in the Debian image provided by BeagleBoard.org.
• TODO: It can be coupled with graphing tools to view quick graphs from various gpio.

Conclusion

• Best to my understanding all major and not obvious goals that were originally proposed have been completed. I will continue to support this project in the future, take care of any bugs, issues and will continue implementing additional features whenever required.

• It has been a really amazing experience for me. I have learned so much in this duration. I would like to thank beagleboard.org and Google for giving me such an amazing opportunity. I would also like to thanks my mentors Arthur, Abhishek, and Deepak for helping me out and supporting me throughout the project, also all the other mentors and organization admin, namely Cathleen, Jason, and Robert who supported me throughout the period, and making sure that I received all the required hardware on time.

Known Issues