OpenBuilds Documentation

Part Store Documentation Software Community Support
docs:blox:firmware-arduino

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
docs:blox:firmware-arduino [2024/08/15 13:24]
admin 		docs:blox:firmware-arduino [2024/08/19 17:38] (current)
admin
Line 1: Line 1:
-======4.2 Using BLOX with the Arduino IDE ======+====== 5.2 Using BLOX with the Arduino IDE ======
  
 The Arduino IDE provides a flexible and powerful environment for programming BLOX devices using traditional code-based methods. This guide will help you get started by installing the Arduino IDE, setting up the ESP32 cores, and adding the necessary libraries. The Arduino IDE provides a flexible and powerful environment for programming BLOX devices using traditional code-based methods. This guide will help you get started by installing the Arduino IDE, setting up the ESP32 cores, and adding the necessary libraries.
  
-=====4.2.1 Requirements=====+---- 
 + 
 +===== 5.2.1 Requirements =====
  
 Before getting started, ensure that you have the following: Before getting started, ensure that you have the following:
  
-- A computer running Windows, macOS, or Linux. +  * A computer running Windows, macOS, or Linux. 
-- An internet connection to download the necessary software and libraries.+  * An internet connection to download the necessary software and libraries. 
 + 
 +----
  
-=====4.2.2 Installing Arduino IDE 2=====+===== 5.2.2 Installing Arduino IDE 2 =====
  
 **Download Arduino IDE 2**: **Download Arduino IDE 2**:
  
-Visit https://www.arduino.cc/en/software and select the appropriate version for your operating system.+Visit [[https://www.arduino.cc/en/software|https://www.arduino.cc/en/software]] and select the appropriate version for your operating system.
  
 **Install the IDE**: **Install the IDE**:
Line 20: Line 24:
 Follow the installation instructions provided on the website. Once the installation is complete, launch the Arduino IDE. Follow the installation instructions provided on the website. Once the installation is complete, launch the Arduino IDE.
  
-=====4.2.3 Installing the ESP32 Cores=====+---- 
 + 
 +===== 5.2.3 Installing the ESP32 Cores =====
  
 **Open the Arduino IDE**: **Open the Arduino IDE**:
Line 30: Line 36:
 In the "Additional Boards Manager URLs" field, enter the following URL: In the "Additional Boards Manager URLs" field, enter the following URL:
  
-> https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json+> [[https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json|https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json]]
  
-      
 Click "OK" to save the preferences. Click "OK" to save the preferences.
  
Line 41: Line 46:
 In the search bar, type "ESP32" and install the latest version of the ESP32 by Espressif Systems. In the search bar, type "ESP32" and install the latest version of the ESP32 by Espressif Systems.
  
-=====4.2.4 Installing the OpenBuilds BLOX Library=====+---- 
 + 
 +===== 5.2.4 Installing the OpenBuilds BLOX Library =====
  
 **Open the Library Manager**: **Open the Library Manager**:
  
 Go to `Sketch > Include Library > Manage Libraries`. Go to `Sketch > Include Library > Manage Libraries`.
- 
  
 **Search for the BLOX Library**: **Search for the BLOX Library**:
Line 54: Line 60:
 Click "Install" to add the library to your Arduino IDE. Click "Install" to add the library to your Arduino IDE.
  
-Alternatively, you can install the library manually by downloading it from the https://github.com/OpenBuilds/OpenBuildsBLOX/+Alternatively, you can install the library manually by downloading it from the [[https://github.com/OpenBuilds/OpenBuildsBLOX/|https://github.com/OpenBuilds/OpenBuildsBLOX/]]
  
-=====4.2.5 Getting Started with BLOX on Arduino IDE=====+---- 
 + 
 +===== 5.2.5 Getting Started with BLOX on Arduino IDE =====
  
 **Select the ESP32-S3 Board**: **Select the ESP32-S3 Board**:
Line 66: Line 74:
 Connect the BLOX device to your computer via USB. Ensure the correct port is selected in `Tools > Port`. Connect the BLOX device to your computer via USB. Ensure the correct port is selected in `Tools > Port`.
  
-Also set: +Also set:
  
   * USB CDC On Boot = Enabled   * USB CDC On Boot = Enabled
Line 77: Line 85:
 {{:docs:blox:pasted:20240814-204154.png}} {{:docs:blox:pasted:20240814-204154.png}}
  
-=====4.2.6 Pinmap for custom firmware =====+---- 
 + 
 +===== 5.2.6 Pinmap for custom firmware ===== 
 + 
 +If you are not planning on using our library to control the onboard devices as part of your code, you can use the Pin map below to get you started with your own code
 <code> <code>
 +
 // WS2812 LEDs // WS2812 LEDs
-#define LED_PIN    48+#define LED_PIN         48 
 + 
 +// RC Servo 
 +#define PIN_SERVO       47
  
 // Stepper 1 // Stepper 1
-const int DIR_1 = 8;  // Stepper1 DIR +#define DIR_1           8 
-const int STEP_1 = 9; // Stepper1 STEP +#define STEP_1          9 
-const int ENABLE_1 = 10; // Stepper1 ENABLE +#define ENABLE_1        10 
-const int FAULT_1 = 11; // Stepper1 Fault+#define FAULT_1         11 
 +// Remember to setup MCP4725 I2C DAC (Addr 0x60) to set Stepper Driver Current
  
 // Stepper 2 // Stepper 2
-const int DIR_2 = 12;  // Stepper2 DIR +#define DIR_2           12 
-const int STEP_2 = 13; // Stepper2 STEP +#define STEP_2          13 
-const int ENABLE_2 = 14; // Stepper2 Enable +#define ENABLE_2        14 
-const int FAULT_2 = 15; // Stepper2 Fault+#define FAULT_2         15 
 +// Remember to setup MCP4725 I2C DAC (Addr 0x61) to set Stepper Driver Current
  
-// Remember to setup 2x MCP4725 I2C DACs (Addr 0x60 and 0x61) to set Stepper Driver Current+// Limits Inputs 
 +#define LIMIT_SENSOR_1  39 
 +#define LIMIT_SENSOR_2  40
  
 // Mosfets // Mosfets
-#define PIN_MOSFET1 41 +#define PIN_MOSFET1     41 
-#define PIN_MOSFET2 42 +#define PIN_MOSFET2     42
- +
-// Limits Inputs +
-#define LIMIT_SENSOR_1 39 // Pin for the first limit sensor +
-#define LIMIT_SENSOR_2 40 // Pin for the second limit sensor+
  
 // Beeper // Beeper
-#define BUZZER_PIN 7+#define BUZZER_PIN      7
  
 // I2C // I2C
-#define I2C_SDA 3 +#define I2C_SDA         3 
-#define I2C_SCL 4+#define I2C_SCL         4
  
 // SPI // SPI
-#define SPI_MOSI 35 +#define SPI_MOSI        35 
-#define SPI_MISO 37 +#define SPI_MISO        37 
-#define SPI_SCK 36+#define SPI_SCK         36
  
 // SD Card // SD Card
-#define SD_CS 5+#define SD_CS           5 
 + 
 +void setCurrent(float milliAmps) { 
 +  // Calculate reference voltage: Convert milliAmps to mV output from DAC 
 +  float millivolt = milliAmps / 5.0 / 0.22; 
 + 
 +  // Map the millivolt value to the DAC range (0 to 3300 mV to 0 to 4096) 
 +  int dacValue = map(millivolt, 0, 3300, 0, 4096); 
 + 
 +  // Your own logic here to apply the dacValue to the correct DAC to set the current 
 +} 
 </code> </code>
 +
 +----
 +
 +
docs/blox/firmware-arduino.1723728284.txt.gz · Last modified: 2024/08/15 13:24 by admin

Page Tools

All works Copyright © by OpenBuilds®, LLC
All rights reserved. This Documentation or any portion thereof including but not limited to (menu structures, images, layout, videos, graphical artwork, logos, names, trademarks, etc.) may not be reproduced or used in any manner whatsoever without the express written permission of OpenBuilds, LLC