Bruce

https://wiki.bruce.computer/
Admin
Bruce is a versatile ESP32 firmware that supports offensive security features for Red Team...
Tokens:43,166
Snippets:460
Trust Score:7
Update:8 months ago
Show doc for...
Tokens:
Raw
### GPIO Example: Blinking an LED

Source: https://wiki.bruce.computer/interpreter

This JavaScript code snippet demonstrates a basic example of controlling an LED using the gpio module. It initializes a GPIO pin as output, then repeatedly turns the LED on and off with a delay. Ensure the 'gpio' module is installed and the specified pin (26) is available and configured correctly.

```javascript
const gpio = require("gpio");

const led = 26;
gpio.init(led, OUTPUT);

gpio.write(led, HIGH);
delay(1000);
gpio.write(led, LOW);
delay(1000);

```

--------------------------------

### Wi-Fi and HTTP Requests Example - wifi

Source: https://wiki.bruce.computer/interpreter

Demonstrates Wi-Fi connectivity and making HTTP requests using the wifi module. It shows how to check connection status, connect to a network, scan for available networks, and perform HTTP GET requests.

```javascript
const wifi = require("wifi");

if (!wifi.connected()) {
  wifi.connect("MySSID", 10, "password123");
}

const networks = wifi.scan();
console.log("Available Networks:", networks);

const response = wifi.httpFetch("https://example.com/api", {
  method: "GET",
  headers: { "Content-Type": "application/json" },
});
console.log(response.body);


```

--------------------------------

### JavaScript Path Module Example in Bruce

Source: https://wiki.bruce.computer/interpreter

Shows how to use the 'dialog' module to pick a file, utilizing the 'Path' object which specifies the file's storage location. This example requires the 'dialog' module to be available.

```javascript
const dialog = require("dialog");
dialog.pickFile({ fs: "user", path: "/" });

```

--------------------------------

### TypeScript to JavaScript Compilation Example

Source: https://wiki.bruce.computer/interpreter

Illustrates the process of compiling TypeScript (.ts) files into JavaScript (.js) files, a necessary step before uploading scripts to the Bruce platform. This is a conceptual example as the actual compilation command is not provided.

```bash
# Conceptual example: Replace 'your_script.ts' with your actual TypeScript file.
tsc your_script.ts

```

--------------------------------

### Install Libraries using PIO Package Manager

Source: https://wiki.bruce.computer/development/help-with-bruce-development

Demonstrates how to search for and install libraries using the PlatformIO (PIO) package manager. This is one of the methods for managing project dependencies.

```bash
pio pkg search mylib
pio pkg install -l mylib

```

--------------------------------

### display.width

Source: https://wiki.bruce.computer/interpreter

Gets the display width.

```APIDOC
## GET /display/width

### Description
Gets the display width.

### Method
GET

### Endpoint
/display/width

### Response
#### Success Response (200)
- **width** (number) - Display width in pixels.

#### Response Example
```json
{
  "width": 320
}
```
```

--------------------------------

### Dialog: Display Message Example

Source: https://wiki.bruce.computer/interpreter

Provides examples of how to use the dialog.message function, including displaying a simple message, blocking until a key press, and handling custom button responses.

```javascript
const dialog = require("dialog");
dialog.message("Hello!"); // Just displays the message
dialog.message("Press any key...", true); // Blocks until a key is pressed
const choice = dialog.message("Choose:", {
  left: "No",
  center: "Maybe",
  right: "Yes",
});
if (choice === "right") console.log("User chose Yes!");
```

--------------------------------

### IR Example: Reading and Transmitting Signals

Source: https://wiki.bruce.computer/interpreter

This JavaScript code snippet demonstrates how to use the 'ir' module to read IR signals and transmit them from a file. It shows reading a signal with a timeout, reading raw signal data, and transmitting a signal stored in '/signals/power_on.ir'. Ensure the 'ir' module is installed and the signal file exists.

```javascript
const ir = require("ir");

const signal = ir.read(5); // Waits up to 5 seconds for an IR signal
console.log("Received IR signal:", signal);

const rawSignal = ir.readRaw(5);
console.log("Received raw IR signal:", rawSignal);

const success = ir.transmitFile("/signals/power_on.ir");
console.log("Transmission successful:", success);

```

--------------------------------

### Install PlatformIO and Clone Repository (Linux)

Source: https://wiki.bruce.computer/development/building-from-source

Installs necessary dependencies like python3-pip, git, and PlatformIO on Linux systems using apt. It also clones the Bruce repository and sets up the environment path.

```bash
sudo apt update
sudo apt install -y --no-install-recommends python3-pip git gcc-multilib libc6-dev-i386
pip3 install platformio
export PATH=$PATH:~/.local/bin
source ~/.bashrc
echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
source ~/.bashrc
git clone https://github.com/pr3y/Bruce.git
cd Bruce
```

--------------------------------

### Device: Get System Information (JavaScript)

Source: https://wiki.bruce.computer/interpreter

Retrieves various system information from the device, including its name, board type, model, battery charge, and free heap memory. This example uses JavaScript and the 'device' module.

```javascript
const device = require("device");

console.log("Device Name:", device.getName());
console.log("Board:", device.getBoard());
console.log("Model:", device.getModel());
console.log("Battery Charge:", device.getBatteryCharge(), "%");

const memoryStats = device.getFreeHeapSize();
console.log("RAM Free:", memoryStats.ram_free);
console.log("PSRAM Free:", memoryStats.psram_free);
```

--------------------------------

### Install PlatformIO and Clone Repository (Fedora)

Source: https://wiki.bruce.computer/development/building-from-source

Installs necessary dependencies like python3-pip and git on Fedora systems using dnf. This is a prerequisite for building the project via command line.

```bash
sudo dnf update
sudo dnf install python3-pip git
```

--------------------------------

### GPIO LEDC PWM Setup: ledcSetup()

Source: https://wiki.bruce.computer/interpreter

Configures a specific LEDC (PWM) channel with a given frequency and bit resolution. This function is crucial for advanced PWM control, allowing precise frequency and duty cycle settings. It returns the actual frequency set.

```typescript
gpio.ledcSetup(
  channel: number,
  freq: number,
  resolution_bits: number,
): number;

```

--------------------------------

### JavaScript Globals Example in Bruce

Source: https://wiki.bruce.computer/interpreter

Demonstrates the usage of global variables and functions available in the Bruce JavaScript environment, such as console logging, delays, type conversions, and string manipulations. It highlights ES5 compatibility.

```javascript
console.log(now()); // console.log prints to serial monitor
delay(1000); // Pause for 1000ms (1 second)
var myNumber = parse_int("2133"); // myNumber will be number 2133
var myString = to_string(24); // myString will be string "24"
var myHexStr = to_hex_string(1337); // myHexStr will be string "539" (because 1337 decimal is 0x539).
var str = "Hello World";
println(to_lower_case(str)); // prints: hello world
println(to_upper_case(str)); // prints: HELLO WORLD
println(random(1, 20)); // prints random value between 1 and 20
println(__dirname); // prints current dirname

```

--------------------------------

### display.height

Source: https://wiki.bruce.computer/interpreter

Gets the display height.

```APIDOC
## GET /display/height

### Description
Gets the display height.

### Method
GET

### Endpoint
/display/height

### Response
#### Success Response (200)
- **height** (number) - Display height in pixels.

#### Response Example
```json
{
  "height": 240
}
```
```

--------------------------------

### Manual Flashing with esptool.py

Source: https://wiki.bruce.computer/how-to-install

This snippet demonstrates how to manually flash the Bruce firmware using the esptool.py command-line utility. It requires downloading the firmware binary and specifying the serial port and flash address. Ensure esptool.py is installed and the correct port is identified.

```bash
esptool.py --port /dev/ttyACM0 write_flash 0x00000 Bruce_device_version.bin
```

--------------------------------

### Sub-GHz Communication Example - subghz

Source: https://wiki.bruce.computer/interpreter

Demonstrates how to use the subghz module for Sub-GHz communication. It includes setting the frequency, reading incoming signals, and transmitting stored signals from a file. Requires the 'subghz' module.

```javascript
const subghz = require("subghz");

// Set frequency to 433 MHz
subghz.setFrequency(433);

// Read incoming signal for 5 seconds
const receivedData = subghz.read(5);
console.log("Received Data:", receivedData);

// Transmit a stored signal file
const success = subghz.transmitFile("/plug1_on.sub");
if (success) {
  console.log("Transmission successful!");
}

```

--------------------------------

### File Storage Operations Example (JavaScript)

Source: https://wiki.bruce.computer/interpreter

Demonstrates various file storage operations including writing, reading, renaming, deleting files, listing directory contents, creating, and removing directories. It utilizes the 'storage' module.

```javascript
const storage = require("storage");

// Write data to a file
const success = storage.write("/data/log.txt", "Hello, world!");
if (success) {
  console.log("File written successfully!");
}

// Read data from a file
const content = storage.read("/data/log.txt");
console.log("File content:", content);

// Rename a file
const renamed = storage.rename("/data/log.txt", "/data/log_old.txt");
console.log("Rename successful:", renamed);

// Delete a file
const deleted = storage.delete("/data/log_old.txt");
console.log("Delete successful:", deleted);

// List directory contents
const files = storage.readdir("/data", { withFileTypes: true });
console.log("Files:\n", JSON.stringify(files, null, 2));

// Create a new directory
storage.mkdir("/data/newdir");

// Remove a directory
storage.rmdir("/data/newdir");

```

--------------------------------

### Access Keyboard Input with keyboard Module

Source: https://wiki.bruce.computer/interpreter

Provides functions to access keyboard input. The example demonstrates how to continuously check for any key press and exit a loop when one is detected. It requires the 'keyboard' module.

```javascript
const keyboard = require("keyboard");

while (true) {
  if (keyboard.getAnyPress()) {
    break; // Exits the loop when a button is pressed.
  }
}
```

--------------------------------

### Dialog: Pick and View File (JavaScript)

Source: https://wiki.bruce.computer/interpreter

Allows the user to pick a file with a specific extension and then view its content. This example uses JavaScript and the 'dialog' module.

```javascript
const dialog = require("dialog");

const filePath = dialog.pickFile("/documents", "txt");
dialog.viewFile(filePath);
```

--------------------------------

### display.gifOpen

Source: https://wiki.bruce.computer/interpreter

Opens a GIF for manual frame playback.

```APIDOC
## POST /display/gifOpen

### Description
Opens a GIF for manual frame playback.

### Method
POST

### Endpoint
/display/gifOpen

### Parameters
#### Request Body
- **path** (string | Path) - Required - The path to the GIF file. Supports: - A string path (e.g., "/images/anim.gif"). - A `Path` object specifying storage { fs: "sd", path: "/images/anim.gif" }.

### Request Example
```json
{
  "path": "/images/anim.gif"
}
```

### Response
#### Success Response (200)
- **gifId** (string) - A unique identifier for the opened GIF object.

#### Response Example
```json
{
  "gifId": "gif_12345"
}
```
```

--------------------------------

### Wi-Fi API

Source: https://wiki.bruce.computer/interpreter

APIs for Wi-Fi connection management and making HTTP requests.

```APIDOC
## GET /wifi/connected

### Description
Checks if the device is connected to a Wi-Fi network.

### Method
GET

### Endpoint
`/wifi/connected`

### Response
#### Success Response (200)
- **connected** (boolean) - `true` if connected, `false` otherwise.

#### Response Example
```json
{
  "connected": true
}
```

## POST /wifi/connect

### Description
Connects the device to a Wi-Fi network.

### Method
POST

### Endpoint
`/wifi/connect`

### Parameters
#### Request Body
- **ssid** (string) - Required - The SSID of the Wi-Fi network.
- **timeoutSeconds** (number) - Required - The maximum time in seconds to attempt connection.
- **password** (string) - Required - The password for the Wi-Fi network.

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the connection attempt (e.g., "connected", "failed").

#### Response Example
```json
{
  "status": "connected"
}
```

## POST /wifi/connectDialog

### Description
Initiates a Wi-Fi connection dialog on the device.

### Method
POST

### Endpoint
`/wifi/connectDialog`

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the dialog initiation (e.g., "started").

#### Response Example
```json
{
  "status": "started"
}
```

## POST /wifi/disconnect

### Description
Disconnects the device from the current Wi-Fi network.

### Method
POST

### Endpoint
`/wifi/disconnect`

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the disconnection (e.g., "disconnected").

#### Response Example
```json
{
  "status": "disconnected"
}
```

## GET /wifi/scan

### Description
Scans for available Wi-Fi networks.

### Method
GET

### Endpoint
`/wifi/scan`

### Response
#### Success Response (200)
- **networks** (array) - An array of available Wi-Fi network objects, each containing details like SSID and signal strength.

#### Response Example
```json
{
  "networks": [
    { "ssid": "MyNetwork1", "rssi": -50 },
    { "ssid": "AnotherNet", "rssi": -75 }
  ]
}
```

## POST /wifi/httpFetch

### Description
Performs an HTTP request.

### Method
POST

### Endpoint
`/wifi/httpFetch`

### Parameters
#### Request Body
- **url** (string) - Required - The URL to fetch.
- **options** (object) - Optional - HTTP request options, including method, headers, and body.
  - **method** (string) - Optional - HTTP method (e.g., "GET", "POST"). Defaults to "GET".
  - **headers** (object) - Optional - Request headers.
  - **body** (string) - Optional - Request body.

### Response
#### Success Response (200)
- **response** (object) - The HTTP response object.
  - **statusCode** (number) - The HTTP status code.
  - **headers** (object) - Response headers.
  - **body** (string) - Response body.

#### Response Example
```json
{
  "response": {
    "statusCode": 200,
    "headers": { "Content-Type": "application/json" },
    "body": "{\"message\": \"Success\"}"
  }
}
```
```

--------------------------------

### BadUSB Functions

Source: https://wiki.bruce.computer/interpreter

Functions for simulating USB keyboard input and releasing keys.

```APIDOC
## badusb.releaseAll()

### Description
Releases all currently held keys.

### Method
`void`

### Endpoint
N/A (Local Function)

### Parameters
None

### Request Example
```javascript
badusb.releaseAll();
```

### Response
#### Success Response (200)
`void`

#### Response Example
N/A
```

```APIDOC
## badusb.print()

### Description
Types a string as keyboard input.

### Method
`void`

### Endpoint
N/A (Local Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **message** (string) - Required - The text to type.

### Request Example
```javascript
badusb.print("Hello, World!");
```

### Response
#### Success Response (200)
`void`

#### Response Example
N/A
```

```APIDOC
## badusb.println()

### Description
Types a string followed by an "Enter" key press.

### Method
`void`

### Endpoint
N/A (Local Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **message** (string) - Required - The text to type.

### Request Example
```javascript
badusb.println("This is a new line.");
```

### Response
#### Success Response (200)
`void`

#### Response Example
N/A
```

```APIDOC
## badusb.runFile()

### Description
Executes a script file from storage.

### Method
`void`

### Endpoint
N/A (Local Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **filename** (string) - Required - The path to the script file.

### Request Example
```javascript
badusb.runFile("/scripts/my_script.txt");
```

### Response
#### Success Response (200)
`void`

#### Response Example
N/A
```

--------------------------------

### wifi.connect()

Source: https://wiki.bruce.computer/interpreter

Connects to a specified Wi-Fi network with a given timeout and password.

```APIDOC
## POST /wifi/connect

### Description
Connects to a Wi-Fi network using the provided SSID, timeout, and password.

### Method
POST

### Endpoint
/wifi/connect

### Parameters
#### Query Parameters
- **ssid** (string) - Required - The name of the Wi-Fi network (SSID).
- **timeoutInSeconds** (number) - Required - The time (in seconds) to wait for a connection before failing.
- **password** (string) - Required - The Wi-Fi password.

### Response
#### Success Response (200)
- **connected** (boolean) - true if connected, otherwise false.

#### Response Example
```json
{
  "connected": true
}
```
```

--------------------------------

### wifi.httpFetch()

Source: https://wiki.bruce.computer/interpreter

Performs an HTTP request to a specified URL with optional configurations.

```APIDOC
## POST /wifi/httpFetch

### Description
Performs an HTTP request to the specified URL. Supports various methods, request bodies, and headers. The response type defaults to string.

### Method
POST

### Endpoint
/wifi/httpFetch

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to fetch.
- **options** (object) - Optional - Request configuration options.
  - **method** (string) - Optional - The HTTP method (e.g., GET, POST, PUT, DELETE). Defaults to GET.
  - **body** (string) - Optional - The request body content.
  - **responseType** (string) - Optional - The expected response type. Can be 'string' or 'binary'. Defaults to 'string'.
  - **headers** (object or array) - Optional - Request headers. Can be a plain object, an array of key-value pairs, or an array of strings.

### Response
#### Success Response (200)
- **status** (number) - The HTTP response status code.
- **ok** (boolean) - True if the response status is 200-299, otherwise false.
- **body** (string or Uint8Array) - The response body, type depends on `responseType` option.

#### Response Example (String Body)
```json
{
  "status": 200,
  "ok": true,
  "body": "<html><body>Success</body></html>"
}
```

#### Response Example (Binary Body)
```json
{
  "status": 200,
  "ok": true,
  "body": "<binary data>"
}
```
```

--------------------------------

### wifi.connectDialog()

Source: https://wiki.bruce.computer/interpreter

Opens a dialog for the user to select and connect to a Wi-Fi network.

```APIDOC
## POST /wifi/connectDialog

### Description
Opens a user interface dialog to allow selection and connection to a Wi-Fi network.

### Method
POST

### Endpoint
/wifi/connectDialog

### Parameters
None

### Response
#### Success Response (200)
- **status** (void) - Indicates the operation completed without returning a value.

#### Response Example
```json
{
  "status": "completed"
}
```
```

--------------------------------

### Dialog: Display Choice Prompt (JavaScript)

Source: https://wiki.bruce.computer/interpreter

Presents the user with a choice dialog containing specified options and returns the user's selection. This example uses JavaScript and the 'dialog' module.

```javascript
const dialog = require("dialog");

const options = ["Yes", "No", "Cancel"];
const selected = dialog.choice(options);
```

--------------------------------

### display.drawJpg

Source: https://wiki.bruce.computer/interpreter

Draws a JPG image on the display.

```APIDOC
## POST /display/drawJpg

### Description
Draws a JPG image on the display.

### Method
POST

### Endpoint
/display/drawJpg

### Parameters
#### Request Body
- **path** (string | Path) - Required - The path to the JPG file. Supports: - A string path (e.g., "/images/photo.jpg"). - A `Path` object specifying storage { fs: "sd", path: "/images/photo.jpg" }.
- **x** (number) - Optional - X-coordinate.
- **y** (number) - Optional - Y-coordinate.
- **center** (boolean) - Optional - Whether to center the image.

### Request Example
```json
{
  "path": "/images/photo.jpg",
  "x": 10,
  "y": 20,
  "center": true
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success ('OK').

#### Response Example
```json
{
  "status": "OK"
}
```
```

--------------------------------

### dialog.prompt()

Source: https://wiki.bruce.computer/interpreter

Opens an on-screen keyboard for user input with optional title, maximum length, and initial value.

```APIDOC
## POST /dialog/prompt

### Description
Opens an on-screen keyboard for user input.

### Method
POST

### Endpoint
/dialog/prompt

### Parameters
#### Request Body
- **title** (string) - Optional - Title of the keyboard prompt.
- **valueLength** (number) - Optional - Maximum length of the input value.
- **value** (string) - Optional - Initial value to display.

### Request Example
```json
{
  "title": "Enter your name",
  "valueLength": 50,
  "value": "Default Name"
}
```

### Response
#### Success Response (200)
- **userInput** (string) - User input.

#### Response Example
```json
{
  "userInput": "John Doe"
}
```
```

--------------------------------

### Device: Get Free Heap Size Information

Source: https://wiki.bruce.computer/interpreter

Retrieves detailed information about the device's memory usage, including free RAM, minimum free RAM, largest free block, total RAM, free PSRAM, and total PSRAM. It returns an object containing these statistics.

```typescript
device.getFreeHeapSize(): {
  ram_free: number;
  ram_min_free: number;
  ram_largest_free_block: number;
  ram_size: number;
  psram_free: number;
  psram_size: number;
};
```

--------------------------------

### wifi.scan()

Source: https://wiki.bruce.computer/interpreter

Scans for available Wi-Fi networks and returns a list of network details.

```APIDOC
## GET /wifi/scan

### Description
Scans the environment for available Wi-Fi networks and returns their details.

### Method
GET

### Endpoint
/wifi/scan

### Parameters
None

### Response
#### Success Response (200)
- **networks** (array) - An array of available Wi-Fi networks.
  - **encryptionType** (string) - The type of encryption used (e.g., OPEN, WPA2_PSK).
  - **SSID** (string) - The name of the Wi-Fi network.
  - **MAC** (string) - The MAC address of the access point.

#### Response Example
```json
{
  "networks": [
    {
      "encryptionType": "WPA2_PSK",
      "SSID": "MyHomeNetwork",
      "MAC": "00:1A:2B:3C:4D:5E"
    },
    {
      "encryptionType": "OPEN",
      "SSID": "GuestWiFi",
      "MAC": "00:1A:2B:3C:4D:5F"
    }
  ]
}
```
```

--------------------------------

### display.drawGif

Source: https://wiki.bruce.computer/interpreter

Draws a GIF image on the display.

```APIDOC
## POST /display/drawGif

### Description
Draws a GIF image on the display.

### Method
POST

### Endpoint
/display/drawGif

### Parameters
#### Request Body
- **path** (string | Path) - Required - The path to the GIF file. Supports: - A string path (e.g., "/images/anim.gif"). - A `Path` object specifying storage { fs: "sd", path: "/images/anim.gif" }.
- **x** (number) - Optional - X-coordinate.
- **y** (number) - Optional - Y-coordinate.
- **center** (boolean) - Optional - Whether to center the image.
- **playDurationMs** (number) - Optional - Duration to play the GIF.

### Request Example
```json
{
  "path": "/images/anim.gif",
  "x": 10,
  "y": 20,
  "center": false,
  "playDurationMs": 5000
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success ('OK').

#### Response Example
```json
{
  "status": "OK"
}
```
```

--------------------------------

### Device Information API

Source: https://wiki.bruce.computer/interpreter

Provides functions to retrieve information about the device hardware and status.

```APIDOC
## device.getName()

### Description
Retrieves the device's name.

### Method
`string`

### Endpoint
N/A (Local Function)

### Parameters
None

### Request Example
```javascript
const deviceName = device.getName();
console.log(deviceName);
```

### Response
#### Success Response (200)
- **name** (string) - The name of the device.

#### Response Example
```json
{
  "name": "MyDevice"
}
```
```

```APIDOC
## device.getBoard()

### Description
Retrieves the board type.

### Method
`string`

### Endpoint
N/A (Local Function)

### Parameters
None

### Request Example
```javascript
const boardType = device.getBoard();
console.log(boardType);
```

### Response
#### Success Response (200)
- **board** (string) - The board identifier.

#### Response Example
```json
{
  "board": "ESP32-DevKitC"
}
```
```

```APIDOC
## device.getModel()

### Description
Retrieves the model name.

### Method
`string`

### Endpoint
N/A (Local Function)

### Parameters
None

### Request Example
```javascript
const modelName = device.getModel();
console.log(modelName);
```

### Response
#### Success Response (200)
- **model** (string) - The model of the device.

#### Response Example
```json
{
  "model": "ESP32"
}
```
```

```APIDOC
## device.getBatteryCharge()

### Description
Retrieves the current battery charge level.

### Method
`number`

### Endpoint
N/A (Local Function)

### Parameters
None

### Request Example
```javascript
const batteryLevel = device.getBatteryCharge();
console.log("Battery: " + batteryLevel + "%");
```

### Response
#### Success Response (200)
- **charge** (number) - The battery charge percentage (0-100).

#### Response Example
```json
{
  "charge": 85
}
```
```

```APIDOC
## device.getFreeHeapSize()

### Description
Retrieves information about the device's memory usage.

### Method
`object`

### Endpoint
N/A (Local Function)

### Parameters
None

### Request Example
```javascript
const memoryStats = device.getFreeHeapSize();
console.log("Free RAM:", memoryStats.ram_free);
console.log("Free PSRAM:", memoryStats.psram_free);
```

### Response
#### Success Response (200)
- **ram_free** (number) - Free RAM available (in bytes).
- **ram_min_free** (number) - Minimum free RAM recorded (in bytes).
- **ram_largest_free_block** (number) - Largest contiguous free RAM block (in bytes).
- **ram_size** (number) - Total RAM size (in bytes).
- **psram_free** (number) - Free PSRAM available (in bytes).
- **psram_size** (number) - Total PSRAM size (in bytes).

#### Response Example
```json
{
  "ram_free": 102400,
  "ram_min_free": 98304,
  "ram_largest_free_block": 81920,
  "ram_size": 524288,
  "psram_free": 2097152,
  "psram_size": 2097152
}
```
```

--------------------------------

### display.drawBitmap

Source: https://wiki.bruce.computer/interpreter

Draws a bitmap at the specified position on the screen.

```APIDOC
## POST /display/drawBitmap

### Description
Draws a bitmap at the specified position on the screen.

### Method
POST

### Endpoint
/display/drawBitmap

### Parameters
#### Request Body
- **x** (number) - Required - X-coordinate for the bitmap.
- **y** (number) - Required - Y-coordinate for the bitmap.
- **bitmap** (ArrayBuffer) - Required - The bitmap data stored in an `ArrayBuffer`. The format depends on `bpp`.
- **width** (number) - Required - The width of the bitmap in pixels.
- **height** (number) - Required - The height of the bitmap in pixels.
- **bpp** (1 | 4 | 8 | 16) - Required - Bits per pixel (16, 8, 4, or 1).
- **palette** (ArrayBuffer) - Optional - A color palette used **only** when `bpp` is 4 or 1. Each entry is a 16-bit color (RGB565).

### Request Example
```json
{
  "x": 50,
  "y": 50,
  "bitmap": "base64EncodedBitmapData",
  "width": 10,
  "height": 10,
  "bpp": 16,
  "palette": "base64EncodedPaletteData" 
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success ('OK').

#### Response Example
```json
{
  "status": "OK"
}
```
```

--------------------------------

### Sub-GHz API

Source: https://wiki.bruce.computer/interpreter

APIs for interacting with Sub-GHz frequencies for reading and transmitting data.

```APIDOC
## POST /subghz/setFrequency

### Description
Sets the frequency for Sub-GHz communication.

### Method
POST

### Endpoint
`/subghz/setFrequency`

### Parameters
#### Request Body
- **freq** (number) - Required - Frequency in MHz (e.g., 433 for 433 MHz).

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation (e.g., "OK").

#### Response Example
```json
{
  "status": "OK"
}
```

## GET /subghz/read

### Description
Reads an incoming signal.

### Method
GET

### Endpoint
`/subghz/read`

### Parameters
#### Query Parameters
- **timeoutSeconds** (number) - Required - Maximum time in seconds to wait for a signal.

### Response
#### Success Response (200)
- **data** (string) - The received signal as a string.

#### Response Example
```json
{
  "data": "<received signal data>"
}
```

## GET /subghz/readRaw

### Description
Reads raw incoming signal data.

### Method
GET

### Endpoint
`/subghz/readRaw`

### Parameters
#### Query Parameters
- **timeoutSeconds** (number) - Required - Maximum time in seconds to wait for a signal.

### Response
#### Success Response (200)
- **data** (string) - The raw received signal as a string.

#### Response Example
```json
{
  "data": "<raw received signal data>"
}
```

## POST /subghz/transmitFile

### Description
Transmits a saved signal from a file.

### Method
POST

### Endpoint
`/subghz/transmitFile`

### Parameters
#### Request Body
- **filename** (string) - Required - The path to the file containing the signal to transmit.

### Response
#### Success Response (200)
- **success** (boolean) - `true` if the transmission was successful, otherwise `false`.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### dialog.viewFile()

Source: https://wiki.bruce.computer/interpreter

Opens and displays a file in a viewer. Execution is blocked until the user exits the viewer.

```APIDOC
## POST /dialog/viewFile

### Description
Opens and displays a file in a viewer. Blocks execution until the user exits.

### Method
POST

### Endpoint
/dialog/viewFile

### Parameters
#### Request Body
- **path** (string) - Required - The file path to view.

### Request Example
```json
{
  "path": "/documents/example.txt"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the operation status.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### dialog.pickFile()

Source: https://wiki.bruce.computer/interpreter

Opens a file picker dialog, allowing the user to select a file. Optionally filters by path and extension.

```APIDOC
## POST /dialog/pickFile

### Description
Opens a file picker dialog and returns the selected file path.

### Method
POST

### Endpoint
/dialog/pickFile

### Parameters
#### Request Body
- **path** (string) - Optional - The initial directory path.
- **extension** (string) - Optional - The file extension filter.

### Request Example
```json
{
  "path": "/documents",
  "extension": "txt"
}
```

### Response
#### Success Response (200)
- **filePath** (string) - The selected file path or null if no file is chosen.

#### Response Example
```json
{
  "filePath": "/documents/example.txt"
}
```
```

--------------------------------

### dialog.choice()

Source: https://wiki.bruce.computer/interpreter

Displays a choice dialog with provided options and returns the user's selection.

```APIDOC
## POST /dialog/choice

### Description
Displays a choice dialog and returns the selected option.

### Method
POST

### Endpoint
/dialog/choice

### Parameters
#### Request Body
- **values** (string[] | [string, string][] | {} | string[][]) - Required - An array of options to choose from. Can also be a nested array or object.

### Request Example
```json
{
  "values": ["Yes", "No", "Cancel"]
}
```

### Response
#### Success Response (200)
- **selectedOption** (string) - The selected option as a string.

#### Response Example
```json
{
  "selectedOption": "Yes"
}
```
```

--------------------------------

### display.drawXBitmap

Source: https://wiki.bruce.computer/interpreter

Draws a monochrome bitmap (XBM Bitmap) at the specified position on the screen.

```APIDOC
## POST /display/drawXBitmap

### Description
Draws a monochrome bitmap (XBM Bitmap) at the specified position on the screen. You can convert images to this format using this online converter: https://www.online-utility.org/image/convert/to/XBM

### Method
POST

### Endpoint
/display/drawXBitmap

### Parameters
#### Request Body
- **x** (number) - Required - X-coordinate for the bitmap.
- **y** (number) - Required - Y-coordinate for the bitmap.
- **bitmap** (ArrayBuffer) - Required - The bitmap data stored in an ArrayBuffer (1-bit per pixel).
- **width** (number) - Required - The width of the bitmap in pixels.
- **height** (number) - Required - The height of the bitmap in pixels.
- **fgColor** (number) - Required - The foreground color (used for `1` bits in the bitmap).
- **bgColor** (number) - Optional - The background color (used for `0` bits in the bitmap). If not provided then the background is transparent.

### Request Example
```json
{
  "x": 50,
  "y": 50,
  "bitmap": "base64EncodedBitmapData", 
  "width": 10,
  "height": 10,
  "fgColor": 16711680,
  "bgColor": 65280
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success ('OK').

#### Response Example
```json
{
  "status": "OK"
}
```
```

--------------------------------

### Storage API

Source: https://wiki.bruce.computer/interpreter

APIs for interacting with the device's storage, including reading directories, renaming, removing files/directories, and creating/removing directories.

```APIDOC
## GET /storage/readdir

### Description
Lists the contents of a directory.

### Method
GET

### Endpoint
`/storage/readdir`

### Parameters
#### Query Parameters
- **path** (string) - Required - The directory path. Supports: - A string path (e.g., `"/file.txt"`). - A `Path` object specifying storage `{ fs: "sd", path: "/file.txt" }`.
- **options.withFileTypes** (boolean) - Optional - If `true`, returns an array of `Dirent` objects with file type info.

### Response
#### Success Response (200)
- **files** (string[]) - An array of files and directories names in the directory. OR
- **dirents** (Dirent[]) - An array of `Dirent` objects with file type info if `withFileTypes` is `true`.

#### Response Example
```json
{
  "files": ["file1.txt", "dir1"]
}
```
OR
```json
{
  "dirents": [
    { "name": "file1.txt", "isFile": true, "isDirectory": false },
    { "name": "dir1", "isFile": false, "isDirectory": true }
  ]
}
```

## POST /storage/rename

### Description
Renames a file or directory.

### Method
POST

### Endpoint
`/storage/rename`

### Parameters
#### Request Body
- **oldPath** (string | Path) - Required - The current path of the file or directory. Supports: - A string path (e.g., `"/file.txt"`). - A `Path` object specifying storage `{ fs: "sd", path: "/file.txt" }`.
- **newPath** (string) - Required - The new path.

### Response
#### Success Response (200)
- **success** (boolean) - `true` if the rename operation was successful, otherwise `false`.

#### Response Example
```json
{
  "success": true
}
```

## POST /storage/remove

### Description
Deletes a file or directory.

### Method
POST

### Endpoint
`/storage/remove`

### Parameters
#### Request Body
- **path** (string | Path) - Required - The path of the file or directory to delete. Supports: - A string path (e.g., `"/file.txt"`). - A `Path` object specifying storage `{ fs: "sd", path: "/file.txt" }`.

### Response
#### Success Response (200)
- **success** (boolean) - `true` if the delete operation was successful, otherwise `false`.

#### Response Example
```json
{
  "success": true
}
```

## POST /storage/mkdir

### Description
Creates a directory, including parent directories if necessary.

### Method
POST

### Endpoint
`/storage/mkdir`

### Parameters
#### Request Body
- **path** (string | Path) - Required - The path to the directory.

### Response
#### Success Response (200)
- **success** (boolean) - `true` if the directory was successfully created, otherwise `false`.

#### Response Example
```json
{
  "success": true
}
```

## POST /storage/rmdir

### Description
Removes an empty directory.

### Method
POST

### Endpoint
`/storage/rmdir`

### Parameters
#### Request Body
- **path** (string | Path) - Required - The path to the directory.

### Response
#### Success Response (200)
- **success** (boolean) - `true` if the directory was successfully removed, otherwise `false`.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### HTTP Fetch API

Source: https://wiki.bruce.computer/interpreter

Performs an HTTP request to a specified URL with configurable options.

```APIDOC
## POST /websites/wiki_bruce_computer

### Description
Performs an HTTP request to a specified URL with configurable options.

### Method
POST

### Endpoint
/websites/wiki_bruce_computer

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **url** (string) - Required - The URL to fetch.
- **options** (object) - Optional - Request options including method, body, and headers.
  - **options.method** (string) - Optional - HTTP method (e.g., GET, POST, DELETE).
  - **options.body** (string) - Optional - The request body.
  - **options.responseType** (string) - Optional - The expected response type ('string' or 'binary').
  - **options.headers** (string[] | [string, string][] | Record<string, string>) - Optional - Request headers.

### Request Example
```json
{
  "url": "https://example.com",
  "options": {
    "method": "GET",
    "headers": {
      "Content-Type": "application/json"
    }
  }
}
```

### Response
#### Success Response (200)
- **status** (number) - The HTTP response status code.
- **ok** (boolean) - True if the response status is 200-299, otherwise false.
- **body** (string | Uint8Array) - The response body.

#### Response Example
```json
{
  "status": 200,
  "ok": true,
  "body": "Success!"
}
```
```
Tokens:
Raw