Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ arrange:
- controlling-device
- configuration
- external-modules
- themes
- wiring-diagrams
- customize-ui
- interpreter
- development
6 changes: 5 additions & 1 deletion docs/controlling-device/.pages
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
title: Controlling Device
title: Controlling Device
arrange:
- user-interface.md
- webui.md
- serial.md
Binary file modified docs/controlling-device/main-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,29 @@ todo: Document other device navigation methods

# User Interface


## Main Menu

![Main Menu](main-menu.png)

At the top is the status bar.

This shows (from left to right):

* The time (if available)
* WireGuard connected/disconnected
* GPS active
* Bluetooth connected
* WebUI active
* WiFi connected
* SD card mounted
* Battery level %, indicator bar and green border charging indication (if available)

The lower part of the screen will show the main user interface.


## Navigation

Depending on your device the way you interact with Bruce may differ.

The common methods include:
Expand All @@ -25,16 +48,3 @@ The common methods include:
* Enter - enter/select
* Esc - back
* [Keyboard Shortcuts](keyboard-shortcuts.md)


## Main Menu

![Main Menu](main-menu.png)

At the top is the status bar.

This shows:

* The time (if available)
* Various status icons
* Battery level and charging indication (if available)
3 changes: 3 additions & 0 deletions docs/customize-ui/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: Customize UI
arrange:
- themes.md
File renamed without changes.
File renamed without changes.
29 changes: 29 additions & 0 deletions docs/external-modules/cc1101.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,38 @@
tags:
- _TODO
todo: Check documentaion works in real world
Move wiring info
---
# CC1101

The CC1101 is a low-power sub-1 GHz RF transceiver module used for wireless communication.

## Modules

### CC1101

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-CC1101.html)

![CC1101](cc1101.png){ width="200" }



## Devices/Wiring Diagrams

### [M5Stack StickC - CC1101/NRF24](../wiring-diagrams/m5stickc/cc1101-nrf24.md)


### [M5Stack StickC - SD Card and CC1101/NRF24](../wiring-diagrams/m5stickc/sd-card-and-cc1101-nrf24.md)


### [M5Stack Cardputer - CC1101/NRF24](../wiring-diagrams/cardputer/cc1101-nrf24.md)


### [M5Stack Cardputer Adv - CC1101/NRF24](../wiring-diagrams/cardputer/cc1101-nrf24.md)


## Connections

> All of these connections are compatible with Bruce and the NRF24 module.

To use the CC1101 in Bruce, turn off your M5 device and connect the module following the pinouts listed in this page.
Expand Down
Binary file added docs/external-modules/cc1101.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/external-modules/ch9329-variant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/external-modules/ch9329.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: CH9329 USB HID
---
# CH9329 USB HID

This module adds USB HID support to devices that do not support this, usually this is non ESP32-S3 devices.


## Modules

### CH9329

**Default Baud Rate:** 9600

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-CH9329.html)

![CH9329](ch9329.png){ width="200" }


### CH9329 Variant

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-CH9329.html)

![CH9329 Variant](ch9329-variant.png){ width="200" }


## Devices/Wiring Diagrams

### [M5Stack StickC - CH9329](../wiring-diagrams/m5stickc/ch9329.md)
Binary file added docs/external-modules/ch9329.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/external-modules/gps-atgm336h.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/external-modules/gps-m5stack-gps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/external-modules/gps-neo6m.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 77 additions & 0 deletions docs/external-modules/gps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: GPS
---
# GPS

Add GPS support to a device. This can be used for [Wardriving](../features/gps.md#wardriving) and [GPS Tracking](../features/gps.md#gps-tracker).


## Configuration

You may need to change the [Baudrate](#baud-rate) and [GPS Pins](#gps-pins) configuration depending on the GPS module and device you are using.

!!! info
Since the GPS modules use UART/serial you need to ensure you swap the TX/RX pins when making the connections.
`TX -> RX` and `RX -> TX`

### Baud Rate

GPS -> Config -> Baudrate

* 9600
* 19200
* 38400
* 57600
* 115200

### GPS Pins

GPS -> Config -> GPS Pins

You can set the RX and TX pins away from their defaults if required.


## Modules

### NEO-6M

**Default Baud Rate:** 9600

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-NEO-6M.html)

![NEO-6M](gps-neo6m.png){ width="200" }


### ATGM336H

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-ATGM336H.html)

**Default Baud Rate:** 9600

![ATGM336H](gps-atgm336h.png){ width="200" }


### M5Stack GPS Module

[Find on M5Stack Store](https://shop.m5stack.com/products/gps-bds-unit-v1-1-at6668)

**Default Baud Rate:** 9600

![M5Stack GPS Module](../external-modules/gps-m5stack-gps.png){ width="200" }


## Devices/Wiring Diagrams

### [M5Stack StickC - GPS](../wiring-diagrams/m5stickc/gps.md)


### [M5Stack Cardputer - GPS](../wiring-diagrams/cardputer/gps.md)


### [M5Stack Cardputer Adv - GPS](../wiring-diagrams/cardputer/gps.md)


### [Lilygo T-Embed CC1101 - GPS](../wiring-diagrams/t-embed/gps.md)


### [CYD - GPS](../wiring-diagrams/cyd/gps.md)
Binary file added docs/external-modules/gt24-external-antenna.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/external-modules/gt24-mini.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/external-modules/gt24.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/external-modules/micro-sd-sniffer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Micro SD Sniffer
---
# Micro SD Sniffer

This module can be used to expose a devices SPI bus to help connect other modules that require SPI.


## Modules

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-Micro-SD-Sniffer.html)

![NEO-6M](micro-sd-sniffer.png){ width="200" }


## Devices/Wiring Diagrams

### [M5Stack Cardputer - CC1101/NRF](../wiring-diagrams/cardputer/cc1101-nrf24.md)
Binary file added docs/external-modules/micro-sd-sniffer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 54 additions & 0 deletions docs/external-modules/nrf24.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: NRF24
---
# NRF24

The NRF24 is a 2.4 GHz low-power RF transceiver module used for short-range wireless communication, with Bruce it can be used to scan the frequency range and jam.


## Configuration

## Modules

### NRF24

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-NRF24.html)

![NRF24](nrf24.png){ width="200" }


### GT24

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-GT24.html)

![GT24](gt24.png){ width="200" }

!!! info
To use the external antenna you need to remove the circled component for best performance.

![GT24 External Antenna](gt24-external-antenna.png){ width="200" }

The [GT24 Mini](#gt24-mini) might be a better module if you want to use the external antenna.




### GT24 Mini

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-GT24-Mini-NRF.html)

![GT24 Mini](gt24-mini.png){ width="200" }


## Devices/Wiring Diagrams

### [M5Stack StickC - CC1101/NRF24](../wiring-diagrams/m5stickc/cc1101-nrf24.md)


### [M5Stack StickC - SD Card and CC1101/NRF24](../wiring-diagrams/m5stickc/sd-card-and-cc1101-nrf24.md)


### [M5Stack Cardputer - CC1101/NRF24](../wiring-diagrams/cardputer/cc1101-nrf24.md)


### [M5Stack Cardputer Adv - CC1101/NRF24](../wiring-diagrams/cardputer/cc1101-nrf24.md)
Binary file added docs/external-modules/nrf24.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions docs/external-modules/sd-card-module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: SD Card Module
---
# SD Card Module

Used to add SD card support to devices that do not have a built in SD card reader.


## Modules

### SD Card Module

[Find on AliExpress](https://www.aliexpress.com/w/wholesale-SD-Card-Module.html)

![SD Card Module](sd-card-module.png){ width="200" }


## Devices/Wiring Diagrams

### [M5Stack StickC - SD Card](../wiring-diagrams/m5stickc/sd-card.md)


### [M5Stack StickC - SD Card and CC1101/NRF24](../wiring-diagrams/m5stickc/cc1101-nrf24.md)
Binary file added docs/external-modules/sd-card-module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions docs/features/others.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@ For more info on creating your own DuckyScripts [read here](https://docs.hak5.or

### Using BadUSB on StickCs and Core/Core2 Devices

You will need to use a CH9329 module like as [this](https://pt.aliexpress.com/item/1005006680094576.html) or [this](https://pt.aliexpress.com/item/1005007031564072.html) to run the BadUSB on your device, wiring it into the Grove connector like this:

![CH3929](others-badusb-ch3929.png)
See more information here [M5StickC - CH9329](../wiring-diagrams/m5stickc/m5stickc-ch9329.png)


## USB Keyboard
Expand Down
1 change: 1 addition & 0 deletions docs/wiring-diagrams/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
title: Wiring Diagrams
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wiring-diagrams/cardputer/cardputer-gps.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/wiring-diagrams/cardputer/cardputer-gps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/wiring-diagrams/cardputer/cc1101-nrf24.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: CC1101/NRF24
---
# Cardputer - CC1101/NRF24

## Items Needed

* [Micro SD Sniffer](../../external-modules/micro-sd-sniffer.md#modules)
* [CC1101](../../external-modules/cc1101.md#modules)
* [NRF24](../../external-modules/nrf24.md#modules)


## Wiring Diagram

The diagram shows a CC1101, the wiring is the same for an NRF24.

[View on Cirkit Designer](https://app.cirkitdesigner.com/project/dbb49090-e599-40da-a76c-5990ae58dba7)

![Cardputer - CC1101](cardputer-cc1101.png){ width="400" }
47 changes: 47 additions & 0 deletions docs/wiring-diagrams/cardputer/gps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: GPS
---
# Cardputer - GPS

## Configuration

More information GPS modules can be found [here](../../external-modules/gps.md).


### Cardputer

**Default Pins:** RX=1 TX=2 follow wiring shown [here](#cardputer_1)


### Cardputer Adv

**Default Pins:** RX=15 TX=13 follow wiring shown [here](#cardputer-adv_1)

**Alternative Pins:** RX=33 TX=32 follow wiring shown [here](#cardputer_1)


## Items Needed

* [GPS Modules](../../external-modules/gps.md#modules)


## Wiring Diagram

### Cardputer

[View on Cirkit Designer](https://app.cirkitdesigner.com/project/70897d29-5d8f-46f0-995e-28ccf1f0e660)

![Cardputer - GPS](cardputer-gps.png){ width="400" }

![Cardputer - GPS](cardputer-gps.jpg){ width="400" }


### Cardputer Adv

This shows wiring for the [default pins](#cardputer-adv) you can wire up using the [alternative pins](#cardputer-adv) using the [Cardputer](#cardputer) diagram.

[View on Cirkit Designer](https://app.cirkitdesigner.com/project/bb5fd016-9079-4cb4-a977-b6764aa94f67)

![Cardputer Adv - GPS](cardputer-adv-gps.png){ width="400" }

![Cardputer Adv - GPS](cardputer-adv-gps.jpg){ width="400" }
Loading