metriics / rpi-usb-gadget

Script to set up a Raspberry PI 4 as a USB gadget.

rpi-usb-gadget

Script for setting up a Raspberry PI 4 as USB gadget.

I can not take full credit for this since I am standing on the shoulders of giants.

• https://gist.github.com/ianfinch/08288379b3575f360b64dee62a9f453f
• https://pastebin.com/VtAusEmf
• https://www.hardill.me.uk/wordpress/2019/11/02/pi4-usb-c-gadget/
• https://github.com/hardillb/rpi-gadget-image-creator/blob/master/usr/local/sbin/usb-gadget.sh-orig

Usage

wget https://raw.githubusercontent.com/kmpm/rpi-usb-gadget/master/rpi4-usb.sh
bash rpi4-usb.sh

If you answer no to any of the questions the script will exit but should be safe to restart. You will be asked to choose between ECM or RNDIS type of network. RNDIS works better if your host is Windows and ECM might be better on Linux/Mac.

If the script doesn't run successfully you might have a broken partial configuration.

FAQ

Q: Can we use RPi4 as USB gadget without providing it power separately?

A: Yes... but. The Raspberry PI 4 can draw up to 3A and that is quite alot. Some USB ports only deliver 100-500 mA and you might not be able to even boot but it I have used it on several normal PCs fine, although with lighter loads. Otherwise you will need to power it separately through the GPIO pins (you can even use the official Raspberry Pi PoE HAT for that).

Q: Does it work with RPi5?

A: Haven't tried it yet and I haven't got any external reports this far. There is no real reason that it shouldn't though.

Warning / License

This script will modify '/boot/[firmware/]config.txt', '/boot/[firmware/]cmdline.txt' and other files. Warning, It might brick your device!

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.