Skip to content

Latest commit

 

History

History
151 lines (116 loc) · 6.61 KB

CONFIGURE_CODE.md

File metadata and controls

151 lines (116 loc) · 6.61 KB
Raw

Code Configuration

The purpose of this document is to provide instructions on how to configure various features of the boards. Once you have configured your features upload your code to the board using the instructions UPLOAD_CODE.md

For details on what configurations are avaialble for this version of code see our main README.md section.

Basically, enabling and disabling features is as simple as using 2 slashes (//) to comment or uncomment code.

!!! WARNING !!! Making changes to the configurations of your board can have unknown side effects and may cause damage. We strongly advise users to exercise caution when making changes to the board's settings, and to only do so if they have a clear understanding of the potential consequences. Improper changes to the board's configurations may result in permanent damage, loss of functionality, or other issues that could impact its performance. If you are unsure about any changes, please contact us on Frankly Built's discord: https://discord.gg/franklybuilt.

Configure features

Using the Arduino IDE open/view the file named config.h to configure features such as sound, Walsh MK-85 chin servo, missile servos as well as servo positions.

Activating Sound

To activate the sound features of the code you will need one of the Crash Works 3D boards that have either the DFPlayerMini or JQ6500 module integrated in the board such as the MK X-D or MK X-J or the external S.U.E. board.

NOTE: Activating sound will change the timing of the faceplate and LEDs to be in sync with the sound effects. If you don't have a sound module and activate the sound code you may experience undesireable effects.

  • Locate the line of code that has #define SOUND
    • Change from:
    //#define SOUND
    • To:
    #define SOUND

For the MK X-D or S.U.E.

  • Locate the line of code that has #define MP3_TYPE DFPLAYER
  • If the code has 2 slashes (//) in front of it, remove the slashes:
    • Change from:
    //#define MP3_TYPE DFPLAYER
    • To:
    #define MP3_TYPE DFPLAYER
  • If the line below it DOES NOT have 2 slashes in front of it, put 2 slashes in front of it:
    • Change from:
    //#define MP3_TYPE JQ6500
    • To:
    #define MP3_TYPE JQ6500

For the MK X-J

  • Locate the line of code that has #define MP3_TYPE DFPLAYER
  • If the code DOES NOT have 2 slashes (//) in front of it, put 2 slashes in front of it:
    • Change from:
    #define MP3_TYPE DFPLAYER
    • To:
    //#define MP3_TYPE DFPLAYER
  • If the line below it has 2 slashes in front of it, remove the 2 slashes in front of it:
    • Change from:
    //#define MP3_TYPE JQ6500
    • To:
    #define MP3_TYPE JQ6500

Adjusting volume

  • In the config.h file, locate the line of code #define VOLUME 27
  • Change the number to your desired volume level where 30 is the maximum value.

Changing from JARVIS to FRIDAY

You can change the sound effects to use either the voice of JARVIS or FRIDAY using the steps below.

  • If you have an A.L.I.S.H.A. board with an SD card like the MK X-D:

    • In the mp3 folder of this repository download the file 0005.mp3
    • Rename the file from 0005.mp3 to 0002.mp3
    • Copy the file 0002.mp3 to your SD card overwriting the existing file. (NOTE: you may need to reload all the mp3 files to your SD card in order as described in the SD card instructions)

  • If you have an ALISHA board with the JQ6500 sound module like the MK X-J:

    • In the config.h file locate the lines of code below and make the following changes: From:
    #define SND_EFFECT_TYPE JARVIS // Uncomment this line for JARVIS sound effects
//#define SND_EFFECT_TYPE FRIDAY // Uncomment this line for FRIDAY sound effects

    To:

    //#define SND_EFFECT_TYPE JARVIS // Uncomment this line for JARVIS sound effects
#define SND_EFFECT_TYPE FRIDAY // Uncomment this line for FRIDAY sound effects

Adjusting Servos

After thorough testing, we've determined that the following servo degree settings are optimal for the majority of faceplate articulations. Before making changes in code, make sure you have properly installed your servo mount, helper arms and faceplate mount in your helmet.

WARNING!!! Making adjustments in code to your servo settings could damage your helmet, board and/or servos and may cause unpredictable servo movements. Read the specifications related to your servos prior to making any changes.

Servo positions

To adjust servo positions locate the following code and change the values in number of degrees:

#define SERVO1_OPEN_POS 20  // set the open position of servo 1
#define SERVO2_OPEN_POS 160 // set the open position of servo 2
#define SERVO1_CLOSE_POS 160 // set the closed position of servo 1
#define SERVO2_CLOSE_POS 20 // set the closed position of servo 2

Servo speed

To adjust servo speed locate the following code and change the values where the maximum value is 255:

#define SERVO_CLOSE_SPEED 175 // set the speed of the servo close function
#define SERVO_OPEN_SPEED 255 // set the speed of the servo opening recommend set to max speed to aid in lift

Disable after open

WARNING!!! By design, the servos are disabled after opening in order to prevent overheating and power drain.

To adjust disabling the servos when the faceplate is in the open position locate the following code and change the value from true to false:

#define SERVO1_DISABLE_AFTER_OPEN true
#define SERVO2_DISABLE_AFTER_OPEN true

PWM values

WARNING!!! Don't change these values unless you really understand Pulse-Width-Modulation and your servo specifications.

Locate the following code and change values as needed:

// Use these settings for manual configuration of servos
#elif (SERVO_TYPE == MANUAL)
#define PWM_HIGH 2500 // Manual Setting of Duty Cycle
#define PWM_LOW  300 // Manual Setting of Duty Cycle
#endif

Activating Pixels

In order to activate programmable LEDs known as NeoPixels or WS2812s you need to use our version of code found here: Iron_Man_Servo v3.2.x