-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
47 changed files
with
1,086 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
--- | ||
title: "⚒️ Nugget Assembly Guide" | ||
description: "Soldering & assembling your DevKitty!" | ||
lead: "Assembling & soldering your new CutieCat!" | ||
date: 2023-05-11T00:52:00-07:00 | ||
lastmod: 2023-05-11T00:52:00-07:00 | ||
draft: true | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "" | ||
identifier: "dev-kit-assembly-5560147284bbc5e978bad89bf75506a4" | ||
weight: 10 | ||
toc: true | ||
--- | ||
|
||
## Parts | ||
|
||
Buy the [DevKitty soldering kit on our webstore](https://shop.devkitty.io)! | ||
| Part | Description | Count | | ||
| --- | --- | --- | | ||
| DevKitty PCB | Partially assembled PCB |1| | ||
| [Microcontroller](https://www.amazon.com/HiLetgo-ESP32-S2FN4R2-ESP32-S2-Type-C-Connect/dp/B0B291LZ99/ref=sr_1_1?crid=3RFAV6TMVXMQB&keywords=s2+mini&qid=1683797716&sprefix=s2+mini%2Caps%2C1335&sr=8-1) | S2 Mini (ESP32-S2 Breakout) | 1 | | ||
| [Screen](https://www.amazon.com/AZDelivery-Pixel-Display-Arduino-Raspberry/dp/B07FYG8MZN/ref=sr_1_1?keywords=SH1106+i2c&qid=1683797747&sr=8-1) | SH1106 I2C Display | 1 | | ||
| Male Header (Short) | S2 Mini Mounting Headers |2| | ||
| *Female Header (Short) | S2 Mini Breakout Headers |2| | ||
| *Female Header (Long) | Expansion Header |1| | ||
|
||
[Learn more about these parts →]() | ||
|
||
Your DevKitty PCB comes with surface mount `Buttons`, `NeoPixel`, and `Qwiic Connector` pre-soldered since these are a little tricky! | ||
|
||
## Steps | ||
|
||
#### 1. Prep the Mounting Headers | ||
Start by soldering the `male headers` to your DevKitty PCB, button side up! | ||
- The short side of the pin headers should poke through | ||
- Using a breadboard can help keep them in place! If not you can rest it carefully flush on the table. | ||
![meep](images/1-Prep.png) | ||
|
||
{{< alert icon="ℹ️" context="info" text="Check out our slim mod before continuing if you want a smaller form-factor!" />}} | ||
|
||
#### 2. Assemble the Microcontroller | ||
`This step is optional!` | ||
|
||
Assemble the microcontroller, by soldering the `short female pin headers` to the inside rows of the S2 Mini. | ||
- You can flip the microcontroller over on a flat surface to solder the pins. | ||
- Be careful not to get solder in the other holes! | ||
![meep](images/3-Microcontroller.png) | ||
|
||
Next, press the `S2 Mini` onto the headers on the back of your DevKitty - and solder! | ||
![meep](images/3-Mount.png) | ||
|
||
#### 3. Solder the Expansion Header | ||
Next, solder on the `long female header` to the side of your DevKitty PCB. You should be able to lay the board flush on a table. | ||
![meep](images/2-Headers.png) | ||
|
||
#### 4. Prep & Solder the Screen | ||
Next, peel off the adhesive tape on your DevKitty PCB, and gently push the `screen` in place. | ||
- Be careful to avoid the edges of the screen! It can crack. | ||
<br> | ||
<br> | ||
<br> | ||
![meep](images/4-Screen.png) | ||
|
||
#### 5. Assemble the Case | ||
Finally, assemble the snap fit case! | ||
|
||
1. Insert the `Bumper Button` into the `Lower Enclosure` | ||
2. Press fit the assembled DevKitty into the `Lower Enclosure` | ||
3. Next, place the `D-Pad` into the `Upper Enclosure`, face down | ||
4. Flip over the `Lower Enclosure`, and snap it into place! | ||
![meep](images/5-Case.png) | ||
|
||
#### 6. Power Your DevKitty! | ||
Plug your DevKitty into a USB-C power source. It should run a simple function tester on the screen and Neopixel if successful. | ||
|
||
Now we're ready to update our firmware! | ||
|
||
![meep](images/5-Case.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
title: "⚒️ Assembly Guide" | ||
description: "Soldering & assembling your DevKitty!" | ||
lead: "Assembling & soldering your new CutieCat!" | ||
date: 2023-05-11T00:52:00-07:00 | ||
lastmod: 2023-05-11T00:52:00-07:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "" | ||
identifier: "assembly-5560147284bbc5e978bad89bf75506a4" | ||
weight: 10 | ||
toc: true | ||
--- | ||
{{< alert icon="⚠️" context="warning" text="Updated pics & assembly video coming by Sep 06 2024." />}} | ||
|
||
<!-- #update# --> | ||
|
||
## ⚙ Parts | ||
![](/images/CutieCat/v0_CutieCat-Parts.png) | ||
|
||
<!-- ![](/images/CutieCat/v0_CutieCat-Package.png) --> | ||
|
||
| Part | Description | | ||
|---|---| | ||
|Microcontroller|ESP32-S3 WiFi & Bluetooth MCU| | ||
|Screen|128x64px SH1106 OLED Display| | ||
|Pin Header|6 Pin Breakout for CutieCat Add-ons| | ||
|Antenna (Patch)|Omni Antenna| | ||
|Antenna (External)|Long-range Antenna| | ||
|
||
{{< alert icon="ℹ️" context="info" text="Learn more about component selection on our hardware guide." />}} | ||
|
||
<!-- ## ℹ️ Soldering Quick Tips | ||
For more tips, check out our soldering guide. --> | ||
|
||
## 🗒 Steps | ||
|
||
### 1. Place the ESP32 | ||
![](/images/update.JPG) | ||
- Start by melting a small "tack" of solder to one of the CutieCat microcontroller pads. This will help us place the ESP32 before committing. | ||
- Center the ESP32 on the microcontroller footprint. | ||
- Reheat the tack of solder until it melts, while pressing down the ESP32. Don't worry about how the first joint looks! | ||
- Let the solder cool! If you need to readjust the microcontroller, simply reheat the joint. | ||
|
||
### 2. Solder the ESP32 | ||
{{< alert icon="⚠️" context="danger" text="Be extra careful not to burn the switch connector, or bridge neighboring pins." />}} | ||
![](/images/update.JPG) | ||
|
||
- a. Solder each remaining pad on the microcontroller! | ||
- b. Ensure the connection is solid by bridging the ESP32 pad & PCB pads | ||
- c. Avoid burning the switch connector! * | ||
|
||
**Switch connector will be moved in update v0.1 design* | ||
|
||
### 3. Solder the Expansion Header | ||
![](/images/update.JPG) | ||
|
||
- a. Insert the 6-Pin Header on the Side | ||
- b. Lay the board & header flush on a flat surface | ||
- c. Solder the joints! | ||
|
||
|
||
### 4. Prep + Solder the Screen | ||
{{< alert icon="⚠️" context="warning" text="Press down on center of screen - the edges are really fragile!" />}} | ||
![](/images/update.JPG) | ||
|
||
- a. Add double-sided foam tape at the bottom of the screen footprint. | ||
- b. Center & press the screen in place. | ||
- c. Solder the screen joints on the back. | ||
<!-- note: correct screen askew --> | ||
|
||
### 5. Antenna & Case Assembly | ||
{{< alert icon="🛈" context="warning" text="Read our long-range mod guide before adding the external antenna!!" />}} | ||
![](/images/update.JPG) | ||
|
||
- a. Snap the patch antenna onto the ESP32 u.fl connector | ||
- b. Insert the D-Pad into the Top Enclosure | ||
- c. Place the CutieCat in face-down | ||
- d. Snap-on the Back Enclosure! | ||
|
||
### 6. Quality Assurance | ||
![](/images/update.JPG) | ||
|
||
- Plug in your CutieCat with USB Type C | ||
- With your board fully assembled, it should power on the QA Firmware! | ||
- Check out our [Firmware Guide]() to load new firmware. | ||
|
||
{{< alert icon="🛈" context="danger" text="If your board doesn't work, check our troubleshooting guide." />}} | ||
|
||
## 🔧 Additional Mods | ||
![](/images/update.JPG) | ||
|
||
Check out our [mods]() section for more, including adding the long-range antenna! | ||
|
||
<!-- #update# --> | ||
- 🔋 [Battery Mod]() | ||
- 📡 [Long-Range Antenna]() | ||
- 🛰 [GPS Mod]() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
title: "👨💻 Developer Guide" | ||
description: "Get started contributing to DevKitty Hardware & Firmware." | ||
lead: "Contribute to DevKitty!" | ||
date: 2023-05-11T00:52:00-07:00 | ||
lastmod: 2023-05-11T00:52:00-07:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "" | ||
identifier: "dev-kit-assembly-5560147284bbc5e978bad89bf75506a4" | ||
weight: 100 | ||
toc: true | ||
--- | ||
{{< alert icon="ℹ️" context="warning" text="This page is under construction." />}} | ||
![](/images/update.JPG) | ||
|
||
## Hardware | ||
Currently not accepting PR's, but fixes & suggestions are welcome! | ||
- [PCB](): Designed in KiCAD | ||
- [Enclosure](): Designed in FreeCAD | ||
|
||
## Firmware | ||
{{< alert icon="ℹ️" context="warning" text="Coming soon" />}} | ||
|
||
## Tools | ||
|
||
### ESPTool | ||
ESPTool is the official tool for managing Espressif chips. It can identify boards, modify flash space, and more! | ||
|
||
##### Install ESPTool | ||
``` | ||
pip3 install esptool.py | ||
``` | ||
|
||
##### Create a Binary | ||
After developing and writing custom firmware to the ESP32, you may wish to extract a fullsize binary that contains your application, and perhaps files on the flash space. | ||
|
||
This is how our ScriptKitty Binary includes default examples in the flash drive. | ||
|
||
```bash | ||
esptool.py read_flash 0 0x400000 <vx.x_binary_ddmmyy>.bin | ||
``` | ||
|
||
##### Flash a Binary | ||
We suggest using ESPtool for writing binaries, but our [web flasher](https://update.devkitty.io) is more accessible for beginners. | ||
```bash | ||
esptool.py write_flash 0 <vx.x_binary_ddmmyy>.bin | ||
``` | ||
|
||
## Documentation | ||
Our documentation is written in Markdown, and rendered as a static site using [Hugo]() with the [Doks Theme](). The source code is [hosted on our GitHub](), and new updates are automatically rendered & hosted on [GitHub pages](). | ||
|
||
This makes it really easy for anyone to contribute a pull request! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
--- | ||
title: "🖥️ Firmware Guide" | ||
description: "Learn to flash & pick the right firmware for DevKitty devices." | ||
lead: "Pick & flash new firmware for your CutieCat!" | ||
date: 2023-05-11T00:52:00-07:00 | ||
lastmod: 2023-05-11T00:52:00-07:00 | ||
draft: false | ||
images: [] | ||
menu: | ||
docs: | ||
parent: "" | ||
identifier: "dev-kit-assembly-5560147284bbc5e978bad89bf75506a4" | ||
weight: 10 | ||
toc: true | ||
--- | ||
{{< alert icon="ℹ️" context="info" text="Our firmware is currently experimental as we continue to explore & make improvements to the DevKitty ecosystem." />}} | ||
|
||
![](/images/update.JPG) | ||
|
||
<!-- #update# --> | ||
<!-- add more pictures --> | ||
|
||
CutieCat comes flashed with [QA Firmware](https://github.com/DevKitty-io/QA-Firmware) to test basic functionality. To start hacking you'll have to load new firmware. If you're adventurous you can even learn to write your own! | ||
|
||
## 💻 Firmware Guide | ||
{{< alert icon="ℹ️" context="warning" text="Pick a firmware, and keep reading to learn how to flash these projects." />}} | ||
|
||
##### Official Firmware | ||
We're constantly adding new features and developing cool hacking tools for the ESP32. Here's a couple projects we've built from [your suggestions](): | ||
- [ScriptKitty](): Attack computers over a USB connection with Keystroke Injection | ||
- [DevKitty Wardriver](): Scan & Map WiFi Devices (WiGLE compatible) | ||
- [DevKitty Sniffer](): Gather WiFi & Bluetooth Recon (Kismet compatible) | ||
|
||
<!-- #update# --> | ||
<!-- post sniffer source code --> | ||
|
||
![](/images/update.JPG) | ||
|
||
##### CircuitPython | ||
Our ESP32-based designs are supported by [CircuitPython](), a lightweight version of Python that lets you develop on the go! | ||
|
||
With CircuitPython, you can build hardware prototypes in minutes. We're working on adding some example projects, but you can check out some [great guides by Adafruit]() in the mean time. Our boards feature a Qwiic / Stemma QT compatible connector that lets you easily interface with their sensors! | ||
|
||
[Download the binary here](). | ||
|
||
<!-- ##### Community Projects | ||
- [DevKitty Wardriver]() | ||
- [ScriptKitty]() | ||
##### Arduino --> | ||
|
||
## ⚡ Flashing Guide | ||
{{< alert icon="ℹ️" context="warning" text="This step uses web serial to flash your board from a web browser, a feature currently only supported through Chrome-based browsers. If you wish to flash via command-line, read our developer guide." />}} | ||
|
||
#### Step 1: DFU Mode | ||
Your ESP32 based board needs to enter `Device Firmware Upgrade` (DFU) mode to be upgraded. Some breakout boards have auto-reset circuits which let the board automatically enter this mode, but you may need to do it manually. | ||
|
||
![](/images/update.JPG) | ||
|
||
**DFU Method 1**: | ||
1. **Hold** down the `Boot` button | ||
2. Plug in the DevKitty | ||
3. **Release** the `Boot` button | ||
|
||
**DFU Method 2**: | ||
1. Plug CutieCat into your computer | ||
2. **Hold** down the `Boot` button | ||
3. **Press & Release** the `Reset` button | ||
|
||
#### Step 2: Download Your Firmware | ||
Download the appropriate `.bin` binary file from the firmware guide above. | ||
|
||
*We're working on adding the binaries to the web UI in the next month!* | ||
|
||
#### Step 3: Flash your binary! | ||
![](/images/update.JPG) | ||
|
||
- In a Chrome browser, visit [update.devkitty.io](https://update.devkitty.io) | ||
- Erase the flash chip | ||
- Upload the binary file to the web UI. Leave the offset at `0x0` | ||
- Hit flash and wait for the upload to finish! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,34 @@ | ||
--- | ||
title: "What is DevKitty?" | ||
description: "Meet DevKitty: Your cat-themed hacking & prototyping companion!" | ||
lead: "Meet DevKitty: Your cat-themed hacking & prototyping companion!" | ||
title: "🐈 Meet CutieCat" | ||
description: "Meet CutieCat: Your cat-themed hacking & prototyping companion!" | ||
lead: "Your cat-themed hacking & prototyping companion!" | ||
date: 2022-08-27T08:48:57+00:00 | ||
lastmod: 2022-08-27T08:48:57+00:00 | ||
draft: false | ||
images: ['Purple_Thumbnail.png'] | ||
menu: | ||
docs: | ||
parent: "get-started" | ||
weight: 100 | ||
weight: 1 | ||
toc: true | ||
--- | ||
{{< alert icon="❤️" context="warning" text="If you have a v0 CutieCat, you're an early supporter of the project! Your feedback & suggestions are cherished." />}} | ||
|
||
![](/images/wardriver/devkitty-wardriver-computer.JPG) | ||
<br/><br/> | ||
**DevKitty is your cat-themed hacking & prototyping companion!** | ||
|
||
With our growing collection of educational guides & videos, DevKitty is putting a hacking classroom in your pocket. DevKitty teaches you as you explore the wireless landscape and audit computers around you! | ||
## What is the CutieCat? | ||
CutieCat is your new hacking & prototyping companion! It's a cat-shaped console that lets you experiment with USB Attacks, Wireless Hacking, and fun mini-projects in CircuitPython. | ||
|
||
Our [CutieCat add-ons]() will get you building prototypes in no time! | ||
|
||
## CutieCat Features | ||
CutieCat is built around the [ESP32](), a WiFi & Bluetooth capable microcontroller that makes it perfect for low-cost wireless hacks! It also supports native USB, which lets you run keystroke injection attacks. | ||
|
||
### What Can DevKitty Do? | ||
DevKitty is a portable hacking console that supports WiFi Hacking, USB Attacks, Wardriving, and more! Its capabilities are growing, and you can even contribute to the platform. | ||
##### Features at a Glance | ||
- Compatible with Adafruit + Sparkfun Sensors | ||
- Wardriving with [WiGLE]() & Kismet Support | ||
- DuckyScript Compatible USB Attacks | ||
- WiFi Reconnaissance | ||
|
||
Right now the following projects are supported: | ||
- ScriptKitty: Cat-Themed USB Hacking! | ||
- Wardriver: Gather Intel on Wireless Networks | ||
- CircuitPython: Bite-sized hacking projects | ||
*More Supported Projects Coming Soon!* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: "Hardware" | ||
description: "Use Cases for the DevKitty" | ||
lead: "" | ||
date: 2020-10-06T08:49:15+00:00 | ||
lastmod: 2020-10-06T08:49:15+00:00 | ||
draft: false | ||
weight: 110 | ||
images: [] | ||
--- |
Oops, something went wrong.