Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Matt-London/pwnagotchi-flipper
Integrate the Flipper Zero with the Pwnagotchi
https://github.com/Matt-London/pwnagotchi-flipper
Last synced: 2 days ago
JSON representation
Integrate the Flipper Zero with the Pwnagotchi
- Host: GitHub
- URL: https://github.com/Matt-London/pwnagotchi-flipper
- Owner: Matt-London
- License: mit
- Created: 2022-10-08T20:44:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T05:03:20.000Z (6 months ago)
- Last Synced: 2024-08-03T13:14:01.090Z (3 months ago)
- Language: C
- Size: 14.6 MB
- Stars: 301
- Watchers: 26
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pwnagotchi-Flipper interface
This program will interface the pwnagotchi with the flipper. This will be accomplished using custom code on the pwnagotchi's end to give the flipper simple rendering instructions over UART.
## Layout
This project is broken down into two parts: flipagotchi and pwnzero
```
pwnagotchi-flipper
|--> flipagotchi/
|--> pwnzero/
```
- flipagotchi is the Flipper-side application
- pwnzero is the pwnagotchi-side application
## Setup
### Flipagotchi Setup (Flipper side)
The flipagotchi app can be downloaded from the flipper app store. If you would like to do things manually then follow these instructions.
1. Connect your Flipper to your computer
2. Clone the Flipper Zero firmware onto your machine
3. Place the ```flipagotchi/``` directory into the ```applications_user/```
4. Open a terminal and navigate to the root of the firmware
5. Execute the following command to compile the app and launch it on the Flipper:
```./fbt launch_app APPSRC=applications_user/flipagotchi```
6. This will now compile and load the app onto your Flipper
### PwnZero Setup (Pwnagotchi side)
This procedure will explain how to configure the Pwnagotchi to use the PwnZero plugin to communicate with the Flipper. Note: You may need to change the pyserial file name based on whichever version pip downloaded for you.
1. On your host machine run `pip3 download pyserial`, this should download a `.whl` file.
2. Take note of the filename of the `.whl` and insert that instead of mine
3. Also on the host, run `scp pyserial-3.5-py2.py3-none-any.whl [email protected]:/home/pi` to transfer the `.whl` file to the pwnagotchi
4. Now on the pwnagotchi install the module as root with `sudo pip3 install /home/pi/pyserial-3.5-py2.py3-none-any.whl`
5. Disable Bluetooth on the Pi by adding ```dtoverlay=disable-bt``` at the bottom of the ```/boot/config.txt``` file
1. This needs to be disabled so that the full UART is directed to ```/dev/serial0```
6. Enter the raspberry pi configuration settings with `sudo raspi-config`
1. Select `Interface Options`
2. Select `Serial Port`
3. Select `No` for shell over serial
4. Select `Yes` for serial enabled
6. Place the PwnZero.py file somewhere on the Pi in either its own folder or a folder with other plugins
7. Edit ```/etc/pwnagotchi/config.toml``` file and set ```main.custom_plugins = "/path/to/plugin/folder"```
8. Follow hardware setup shown in `doc/HardwareSetup.md` to connect the devices
9. Restart the Pwnagotchi and open the Flipagotchi app on the Flipper Zero
### Setup note
[Chrismettal](https://github.com/Chrismettal) has designed a "backpack" for the Flipper Zero which is a board that allows you to cleanly attach various devices to the Flipper. They have created one for the Raspberry Pi Zero W which would be a great way to keep your Flipagotchi tidy! Here is a link to their [project](https://github.com/Chrismettal/flipper-zero-backpacks#raspberry-pi-zero-w).
## Development stages
### Stage 1: Simple display rendering
- Stage 1 will focus on getting the Pwnagotchi display to render on the Flipper's display
### Stage 2: App interaction
- Stage 2 will allow the user to interact and control the pwnagotchi using the Flipper's interface
## Contributing
If you would like to contribute, you may make a pull request. It will be helpful if you first open an issue describing the change that you are interested in contributing.
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Disclaimer
This program is meant for educational purposes ONLY. I disclaim any and all responsibility for the usage of this program by external parties (not me).