How can I contribute?#
The most obvious way to contribute is using the OpenBeagle (BeagleBoard.org GitLab server) to report bugs, suggest enhancements and providing merge requests, also called pull requests, the provide fixes to software, hardware designs and documentation.
Reading the help guide is a great way to get started using OpenBeagle.
Tackle to-do list#
This documentation has a number of todo
items where help is needed that can be searched in the source. This list will
show up directly in the staging documentation at https://docs.beagleboard.io/latest/intro/contribution/how.html#contribution-todo-list
Todo
We need a 404 document to help people handle broken links (report, find, etc.).
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/404.rst, line 8.)
Todo
add cape compatibility details
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/01-introduction.rst, line 75.)
Todo
Variable & MAC Memory
VSYS_IO_3V3
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/04-expansion.rst, line 1666.)
Todo
Clean/Update table
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/04-expansion.rst, line 1691.)
Todo
Align with other boards and migrate away from pin usage entries for BeagleBone Black expansion
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/04-expansion.rst, line 1761.)
Todo
Add BeagleBone AI-64 cape mechanical characteristics**
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/04-expansion.rst, line 2131.)
Todo
Update everything taken from BBB chapters to BB AI-64 compatible text.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/04-expansion.rst, line 2172.)
Todo
IMX219 CSI sensor connection with BeagleBone® AI-64 for Edge AI
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst, line 78.)
Todo
BeagleBone® AI-64 wallpaper upon boot
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst, line 182.)
Todo
Microsoft Visual Studio Code for connecting to BeagleBone® AI-64 for Edge AI via SSH
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/edge_ai_apps/getting_started.rst, line 243.)
Todo
Update to latest text from Texas Instruments Edge AI docs
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai-64/edge_ai_apps/index.rst, line 6.)
Todo
Need info on BBAI boot mode settings
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/03-design-and-specifications.rst, line 266.)
Todo
Need info on BBAI power management
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/03-design-and-specifications.rst, line 271.)
Todo
Add WiFi/Bluetooth/Ethernet
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/03-design-and-specifications.rst, line 276.)
Todo
This text needs to go somewhere.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/03-design-and-specifications.rst, line 283.)
Todo
(Schematic screenshot)
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/03-design-and-specifications.rst, line 373.)
Todo
Verify it isn’t better than this. Doesn’t seem right.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/03-design-and-specifications.rst, line 504.)
Todo
Notes regarding the resistors on muxed pins.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 922.)
Todo
(Actually, on BeagleBone AI, I believe PWR_BUT is pulled to 3.3V, but activation is still done by pulling the signal to GND. Also, a quick grounding of PWR_BUT will trigger a system event where shutdown can occur, but there is no hardware power-off function like on BeagleBone Black via this signal. It does, however, act as a hardware power-on.)
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 964.)
Todo
(On BeagleBone Black, SYS_RESET was a bi-directional signal, but it is only an output from BeagleBone AI to capes on BeagleBone AI.)
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 970.)
Todo
This table needs entries
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1484.)
Todo
Table entries needed
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1576.)
Todo
Need info on BealgeBone AI serial debug
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1590.)
Todo
Need info on BealgeBone AI USB Type-C connection
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1595.)
Todo
Need info on BealgeBone AI USB Type-A connection
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1600.)
Todo
Need info on BealgeBone AI USB Gigabit Ethernet connection
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1605.)
Todo
Need info on BealgeBone AI u.FL antenna connection
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1610.)
Todo
Need info on BealgeBone AI uSD card slot
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1615.)
Todo
Need info on BealgeBone AI uHDMI connection
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1620.)
Todo
Add BeagleBone-AI content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1633.)
Todo
Add BeagleBone-AI BeagleBone® Black Cape Compatibility
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1638.)
Todo
Add BeagleBone-AI EEPROM
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1645.)
Todo
Add BeagleBone-AI Pin Usage Consideration
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1650.)
Todo
Add BeagleBone-AI GPIO
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1655.)
Todo
Add BeagleBone-AI I2C
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1660.)
Todo
Add BeagleBone-AI content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1733.)
Todo
Add BeagleBone-AI SPI
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1738.)
Todo
Add BeagleBone-AI Analog
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1743.)
Todo
Add BeagleBone-AI PWM, TIMER, eCAP or PRU PWM/eCAP
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1750.)
Todo
Add BeagleBone-AI eQEP
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1755.)
Todo
Add BeagleBone-AI CAN
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1760.)
Todo
Add BeagleBone-AI McASP (audio serial like I2S and AC97)
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1767.)
Todo
Add BeagleBone-AI MMC
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1772.)
Todo
Add BeagleBone-AI LCD
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1777.)
Todo
Add BeagleBone-AI PRU GPIO
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1782.)
Todo
Add BeagleBone-AI CLKOUT
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1787.)
Todo
discuss header options for working with the expansion connectors per https://git.beagleboard.org/beagleboard/beaglebone-black/-/wikis/System-Reference-Manual#section-7-1
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1792.)
Todo
Add BeagleBone-AI Signal Usage
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1798.)
Todo
Add BeagleBone-AI Cape Power
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1803.)
Todo
Add BeagleBone-AI Mechanical
section content
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/04-expansion.rst, line 1808.)
Todo
Reference https://docs.beagleboard.org/latest/intro/support/index.html and https://beagleboard.org/resources
Related TI documentation: http://www.ti.com/tool/BEAGLE-3P-BBONE-AI
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/06-support.rst, line 9.)
Todo
Add production boot media link in _static/epilog/production.image
and reference it here.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/ai/06-support.rst, line 19.)
Todo
Make all figure references actual references
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/black/ch07.rst, line 1163.)
Todo
move accessory links to a single common document for all boards.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/black/ch07.rst, line 1184.)
Todo
We should include all support information in docs.beagleboard.org now and leave eLinux to others, freeing it as much as possible
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/black/ch07.rst, line 1194.)
Todo
We are going to work on a unified accessories page for all the boards and it should replace this.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/blue/accessories.rst, line 6.)
Todo
Add production boot media link in _static/epilog/production.image
and reference it here.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglebone/blue/faq.rst, line 13.)
Todo
Image with what’s inside the box and a better description.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/02-quick-start.rst, line 14.)
Todo
Describe how to get a serial connection.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/02-quick-start.rst, line 41.)
Todo
Describe how to get an IEEE802.15.4g connection from BeaglePlay.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/02-quick-start.rst, line 48.)
Todo
Describe how to get to a local console and websockets console.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/02-quick-start.rst, line 59.)
Todo
Add BeagleConnect Freedom expansion chapter content.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/04-expansion.rst, line 6.)
Todo
Find a place for the following notes:
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/demos-and-tutorials/using-greybus.rst, line 116.)
Todo
Need to describe functionality of 0.2.2
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/demos-and-tutorials/using-micropython.rst, line 201.)
Todo
note the tested version of software for BeaglePlay
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/demos-and-tutorials/using-zephyr.rst, line 40.)
Todo
describe how to know it is working
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/freedom/demos-and-tutorials/using-zephyr.rst, line 42.)
Todo
provide images demonstrating Jupyter Notebook visualization
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/index.rst, line 64.)
Todo
provide image illustrating remote management
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/index.rst, line 75.)
Todo
think a bit more about this section with some feedback from Cathy.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleconnect/index.rst, line 83.)
Todo
Add specific power-up/down sequence notes here as well a highlight any limitations and known issues.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/03-design.rst, line 144.)
Todo
Add notes on changing SSID/Password
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/connect-wifi.rst, line 344.)
Todo
Add the below changes to the beagle defconfig
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/low-power-video-doorbell.rst, line 99.)
Todo
Add more information on how each gst command is working.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/low-power-video-doorbell.rst, line 157.)
Todo
To make it stick, …
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 148.)
Todo
Document kernel version that integrates this overlay and where to get update instructions.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 254.)
Todo
How do turn off the driver?
How do turn on spidev?
How do I enable GPIO?
How do a provide a manifest?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 299.)
Todo
Needs udev
Needs live description
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/using-mikrobus.rst, line 307.)
Todo
Describe how to know it is working
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 56.)
Todo
A big part of what is missing here is to put your BeaglePlay on the Internet such that we can download things in later steps. That has been initially brushed over.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 67.)
Todo
west build -d build/sensortest zephyr/samples/boards/beagle_bcf/sensortest -- -DOVERLAY_CONFIG=overlay-subghz.conf
west build -d build/wpanusb modules/lib/wpanusb_bc -- -DOVERLAY_CONFIG=overlay-subghz.conf
west build -d build/bcfserial modules/lib/wpanusb_bc -- -DOVERLAY_CONFIG=overlay-bcfserial.conf -DDTC_OVERLAY_FILE=bcfserial.overlay
west build -d build/greybus modules/lib/greybus/samples/subsys/greybus/net -- -DOVERLAY_CONFIG=overlay-802154-subg.conf
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 351.)
Todo
Describe how to handle the serial connection
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagleplay/demos-and-tutorials/zephyr-cc1352-development.rst, line 391.)
Todo
remove “<To-Do>” items in the table below.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/01-introduction.rst, line 55.)
Todo
add instructions for flashing in windows.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/02-quick-start.rst, line 197.)
Todo
add instructions for flashing in Mac.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/02-quick-start.rst, line 201.)
Todo
We need a CSI capture and DSI display demos
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/05-demos.rst, line 7.)
Todo
We need a cape compatibility layer demo
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/05-demos.rst, line 11.)
Todo
update details
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/06-support.rst, line 22.)
Todo
update details
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/ahead/06-support.rst, line 31.)
Todo
add image & information about box content.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/02-quick-start.rst, line 14.)
Todo
We need a CSI capture demos
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/05-demos.rst, line 6.)
Todo
We need a cape compatibility layer demo
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/05-demos.rst, line 10.)
Todo
Add production boot media link in _static/epilog/production.image
and reference it here.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/06-support.rst, line 12.)
Todo
update details
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/06-support.rst, line 22.)
Todo
update details
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/06-support.rst, line 31.)
Todo
This is the hard way! Special cables and FlashPros are not required when using the firmware we initially ship on the board. This tutorial should be rescripted as how to _unbrick_ your board. Also, we have other work-arounds using software and GPIOs rather than FlashPros. Let’s not put this in user’s face as the experience when it is far more painful than using the change-gateware.sh script and “hold BOOT button when applying power” solutions we’ve created!
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/demos-and-tutorials/flashing-board.rst, line 6.)
Todo
Make sure people know about the alternative and we provide links to details on that before we send them down this process.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beaglev/fire/demos-and-tutorials/mchp-fpga-tools-installation-guide.rst, line 13.)
Todo
Add AM67A SoC details
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/01-introduction.rst, line 62.)
Todo
Update BeagleY-AI what’s included in the box section as per production release.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/02-quick-start.rst, line 9.)
Todo
Attaching antennas instructions for BeagleY-AI
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/02-quick-start.rst, line 20.)
Todo
BeagleY-AI unboxing video
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/02-quick-start.rst, line 22.)
Todo
Describe how to build expansion hardware for BeagleY-AI
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/04-expansion.rst, line 6.)
Todo
Add production boot media link in _static/epilog/production.image
and reference it here.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/06-support.rst, line 12.)
Todo
ADD CSI 0/1 Header Location photo.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/demos/arducam-imx219-v3link-dual-camera-kit.rst, line 21.)
Todo
remove notes about work-in-progress. they just make the site more janky.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/demos/beagley-ai-expansion-nvme.rst, line 6.)
Todo
Add more information on Waveshare motor & servo driver HAT.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/demos/pca9685-motor-drivers.rst, line 105.)
Todo
Expand on running 2 DC motor objects
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/beagley/ai/demos/pca9685-motor-drivers.rst, line 229.)
Todo
figure out if BONE-SPI0_0 and BONE-SPI0_1 can be loaded at the same time
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 581.)
Todo
We need a udev rule to make sure the ADC shows up at /dev/bone/adc! There’s nothing for sure that IIO devices will show up in the same place.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 750.)
Todo
I think we can also create symlinks for each channel based on which device is there, such that we can do /dev/bone/adc/Px_y
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 752.)
Todo
I believe a multiplexing IIO driver is the future solution
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 754.)
Todo
remove deep references to git trees
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 849.)
Todo
Additional quadrature encoders can be implemented in PRU firmware.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 947.)
Todo
This doesn’t include any abstraction yet.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 1018.)
Todo
Describe I2S and ALSA
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 1218.)
Todo
Document dynamic DT overlays
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 1471.)
Todo
Document dynamic pinmux control
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 1478.)
Todo
Describe how the Device Trees expose symbols for reuse across boards
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 1490.)
Todo
The steps used to verify all of these configurations is to be documented here. It will serve to document what has been tested, how to reproduce the configurations, and how to verify each major triannual release. All faults will be documented in the issue tracker.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/cape-interface-spec.rst, line 1526.)
Todo
Get OSHWA certification for all of our capes and update the documentation to reflect that
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/boards/capes/index.rst, line 9.)
Todo
fix deg
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/02sensors/sensors.rst, line 719.)
Todo
Remove?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/02sensors/sensors.rst, line 1104.)
Todo
is this up to date?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/05tips/tips.rst, line 732.)
Todo
update
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/05tips/tips.rst, line 765.)
Todo
Test this
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/05tips/tips.rst, line 854.)
Todo
switch to ip address
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/05tips/tips.rst, line 940.)
Todo
check this iptables, convert to ufw
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/05tips/tips.rst, line 967.)
Todo
update
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/05tips/tips.rst, line 1198.)
Todo
verify this works. fonts are taking too long to load
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/06iot/iot.rst, line 502.)
Todo
Is this true: (The plot is wrong, but eLinux won’t let me fix it.)
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/06iot/iot.rst, line 594.)
Todo
My twilio account is suspended, using yoder@rose-hulman.edu.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/06iot/iot.rst, line 665.)
Todo
Start Here. Update for python.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/06iot/iot.rst, line 866.)
Todo
Add cape examples of various sizes
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/09capes/capes.rst, line 18.)
Todo
Update display cape example
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/beaglebone-cookbook/09capes/capes.rst, line 23.)
Todo
Switch from LEDscape to FPP
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 36.)
Todo
verify these commands
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 111.)
Todo
Recheck
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 341.)
Todo
This is currently broken with the latest version of Falcon Christmas (no F8-B-20.json file)
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 431.)
Todo
Show how to drive ws2812’s with FPP.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 445.)
Todo
document the code
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 595.)
Todo
update the figures.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 759.)
Todo
update this
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/01case/case.rst, line 863.)
Todo
Update links
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/02start/start.rst, line 178.)
Todo
The ‘s and _’s in the code are messing with the formatting.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/02start/start.rst, line 333.)
Todo
The version of code used needs to be noted in the documentation.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/03details/details.rst, line 42.)
Todo
Why is this documented in multiple places?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/03details/details.rst, line 44.)
Todo
does this need updating?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/03details/details.rst, line 346.)
Todo
Isn’t working on Pocket at this time.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/04debug/debug.rst, line 113.)
Todo
Check these on the Black and Pocket without grove
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/04debug/debug.rst, line 283.)
Todo
Add code for Blue.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/04debug/debug.rst, line 392.)
Todo
Include a section on accessing DDR.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/05blocks/blocks.rst, line 31.)
Todo
fill in Blue
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/05blocks/blocks.rst, line 483.)
Todo
get this working on the 5.10 kernel
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/05blocks/blocks.rst, line 1584.)
Todo
Test this
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/05blocks/blocks.rst, line 1723.)
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/books/pru-cookbook/05blocks/blocks.rst, line 1816.)
Todo
Place-holder for Arm tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/arm.rst, line 6.)
Todo
Write assembly guide
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/assembly.rst, line 9.)
Todo
Place-holder for electronics wiring tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/basic-wiring.rst, line 6.)
Todo
Place-holder for Buildroot tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/buildroot.rst, line 6.)
Todo
Place-holder for tutorial on the C programming language
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/c.rst, line 6.)
Todo
Place-holder for Debian tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/debian.rst, line 6.)
Todo
Place-holder for Device Tree tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/device-tree.rst, line 6.)
Todo
Place-holder for embedded serial interfaces tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/embedded-serial.rst, line 6.)
Todo
Place-holder for FPGA tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/fpga.rst, line 6.)
Todo
Make sure we have everything critical from https://beagleboard.github.io/bone101/Support/bone101/
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/index.rst, line 133.)
Todo
Place-holder for Motors tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/motors.rst, line 6.)
Todo
Place-holder for OpenBeagle CI tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/openbeagle-ci.rst, line 6.)
Todo
Create a simple drawing of BeaglePlay connecting to an external add-on with an interesting device on it.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/qwiic-stemma-grove-addons.rst, line 12.)
Todo
Place-holder for RISC-V tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/riscv.rst, line 6.)
Todo
Place-holder for verification tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/verification.rst, line 6.)
Todo
Place-holder for tutorial on the Verilog programming language
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/verilog.rst, line 6.)
Todo
Place-holder for Wireless Communications tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/wireless-communications.rst, line 6.)
Todo
Place-holder for Zephyr tutorial
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/beagle101/zephyr.rst, line 6.)
Todo
We need to describe how to use the “Web IDE” to work with OpenBeagle respositories.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/contribution/git-usage.rst, line 189.)
Todo
Why “device” drivers?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/contribution/linux-upstream.rst, line 148.)
Todo
Why do we need drivers?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/contribution/linux-upstream.rst, line 152.)
Todo
What do drivers look like?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/intro/contribution/linux-upstream.rst, line 156.)
Todo
How can we add a step in here to show the network is connected without needing gbridge to be fully functional?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 230.)
Todo
update the below for the built-in sensors
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 351.)
Todo
can we also handle the case where these sensors are included and recommend them? Same firmware?
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 353.)
Todo
the current demo is for the built-in sensors, not the Click boards mentioned below
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 355.)
Todo
this log needs to be updated
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 361.)
Todo
bring in the GPIO toggle and I2C explorations for greater understanding
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 380.)
Todo
revisit everything below here
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 625.)
Todo
The patches for gb-netlink will eventually be applied here until pushed into mainline.
(The original entry is located in /builds/andrei1998/docs-beagleboard-io-fixes/projects/beagleconnect/index.rst, line 746.)
Google Summer of Code (GSoC)#
For newcomers venturing into the realm of open-source contribution, Google Summer of Code (GSoC) stands as an invaluable platform. GSoC provides a unique opportunity to collaborate with the open-source community, engaging in the identification and development of exciting projects during the summer term.
BeagleBoard.org serves as a mentorship organization that takes part in the Google Summer of Code program actively, giving students the opportunity to work on open-source projects during the summer. Visit our dedicated Google Summer of Code (GSoC) for more information about this program, including past projects and mentorship opportunities.
Reporting bugs#
Start by reading the OpenBeagle Issues help page.
Please request an account and report any issues on the appropriate project issue tracker at https://openbeagle.org.
Report issues on the software images at https://openbeagle.org/explore/topics/distros.
Report issues on the hardware at https://openbeagle.org/explore/projects/topics/boards.
Suggesting enhancements#
An issue doesn’t have to be something wrong, it can just be about making something better. If in doubt how to make a productive suggestion, hop on the forum and live chat groups to see what other people say. Check the current ideas that are already out there and give us your idea. Try to be constructive in your suggestion. We are a primarily a volunteer community looking to make your experience better, as those that follow you, and your suggestion could be key in that endeavor.
Where available, use the “enhancement” label on your issue to make sure we know you are looking for a future improvement, not reporting something critically wrong.
Submitting merge requests#
If you want to contribute to a project, the most practical way is with a merge request. Start by creating a fork, which is your own copy of the project you can feel free to edit how you see fit. When ready, create a merge request and we’ll review your work and give comments back to you. If suitable, we’ll update the code to include your contribution!
A bit more detailed suggestions can be found in the articles linked below.