393 lines
8.9 KiB
C
393 lines
8.9 KiB
C
#ifndef SETTINGS_H
|
|
#define SETTINGS_H
|
|
|
|
#include <EEPROM.h>
|
|
#include "sound.h"
|
|
|
|
// change this whenever the saved settings are not compatible with a change
|
|
// It forces a reset from defaults.
|
|
#define SETTINGS_VERSION 1
|
|
#define EEPROM_SIZE 256
|
|
|
|
// LEDS
|
|
#define DEFAULT_BRIGHTNESS 150
|
|
#define MIN_BRIGHTNESS 10
|
|
#define MAX_BRIGHTNESS 255
|
|
|
|
// PLAYER
|
|
const uint8_t MAX_PLAYER_SPEED = 10; // Max move speed of the player
|
|
const uint8_t LIVES_PER_LEVEL = 3; // default lives per level
|
|
#define MIN_LIVES_PER_LEVEL 3
|
|
#define MAX_LIVES_PER_LEVEL 9
|
|
|
|
// JOYSTICK
|
|
#define JOYSTICK_ORIENTATION 1 // 0, 1 or 2 to set the axis of the joystick
|
|
#define JOYSTICK_DIRECTION 1 // 0/1 to flip joystick direction
|
|
#define DEFAULT_ATTACK_THRESHOLD 30000 // The threshold that triggers an attack
|
|
#define MIN_ATTACK_THRESHOLD 20000
|
|
#define MAX_ATTACK_THRESHOLD 30000
|
|
|
|
|
|
#define DEFAULT_JOYSTICK_DEADZONE 8 // Angle to ignore
|
|
#define MIN_JOYSTICK_DEADZONE 3
|
|
#define MAX_JOYSTICK_DEADZONE 12
|
|
|
|
// AUDIO
|
|
#define DEFAULT_VOLUME 180 // 0 to 255
|
|
#define MIN_VOLUME 0
|
|
#define MAX_VOLUME 255
|
|
|
|
|
|
|
|
|
|
#define DAC_AUDIO_PIN 25 // should be 25 or 26 only
|
|
|
|
enum ErrorNums{
|
|
ERR_SETTING_NUM,
|
|
ERR_SETTING_RANGE
|
|
};
|
|
|
|
//EEPROMClass SETTINGS("eeprom", 0x100);
|
|
|
|
//TODO ... move all the settings to this file.
|
|
|
|
// Function prototypes
|
|
//void reset_settings();
|
|
void settings_init();
|
|
void show_game_stats();
|
|
void settings_eeprom_write();
|
|
void settings_eeprom_read();
|
|
void change_setting(char *line);
|
|
void processSerial(char inChar);
|
|
void printError(int reason);
|
|
void show_settings_menu();
|
|
void reset_settings();
|
|
|
|
SemaphoreHandle_t xMutex;
|
|
|
|
|
|
typedef struct {
|
|
uint8_t settings_version; // stores the settings format version
|
|
|
|
//due to the fastLED classes there is not much we can change dynamically
|
|
uint8_t led_brightness;
|
|
|
|
uint8_t joystick_deadzone;
|
|
uint16_t attack_threshold;
|
|
|
|
uint8_t audio_volume;
|
|
|
|
uint8_t lives_per_level;
|
|
|
|
// saved statistics
|
|
uint16_t games_played;
|
|
uint32_t total_points;
|
|
uint16_t high_score;
|
|
uint16_t boss_kills;
|
|
|
|
}settings_t;
|
|
|
|
settings_t user_settings;
|
|
|
|
#define READ_BUFFER_LEN 10
|
|
#define CARRIAGE_RETURN 13
|
|
char readBuffer[READ_BUFFER_LEN];
|
|
uint8_t readIndex = 0;
|
|
|
|
void settings_init() {
|
|
|
|
settings_eeprom_read();
|
|
show_settings_menu();
|
|
show_game_stats();
|
|
}
|
|
|
|
void checkSerialInput() {
|
|
if (Serial.available()) {
|
|
processSerial(Serial.read());
|
|
}
|
|
}
|
|
|
|
void processSerial(char inChar)
|
|
{
|
|
readBuffer[readIndex] = inChar;
|
|
switch(readBuffer[readIndex]){
|
|
case '?':
|
|
readIndex = 0;
|
|
show_settings_menu();
|
|
return;
|
|
break;
|
|
|
|
case 'R':
|
|
readIndex = 0;
|
|
reset_settings();
|
|
settings_eeprom_write();
|
|
delay(1000);
|
|
ESP.restart();
|
|
return;
|
|
break;
|
|
|
|
case 'P':
|
|
user_settings.games_played = 0;
|
|
user_settings.total_points = 0;
|
|
user_settings.high_score = 0;
|
|
user_settings.boss_kills = 0;
|
|
settings_eeprom_write();
|
|
return;
|
|
break;
|
|
|
|
default:
|
|
|
|
break;
|
|
}
|
|
|
|
if (readBuffer[readIndex] == CARRIAGE_RETURN) {
|
|
if (readIndex < 3) {
|
|
// not enough characters
|
|
readIndex = 0;
|
|
}
|
|
else {
|
|
readBuffer[readIndex] = 0; // mark it as the end of the string
|
|
change_setting(readBuffer);
|
|
readIndex = 0;
|
|
}
|
|
}
|
|
else if (readIndex >= READ_BUFFER_LEN) {
|
|
readIndex = 0; // too many characters. Reset and try again
|
|
}
|
|
else
|
|
readIndex++;
|
|
}
|
|
|
|
void change_setting(char *line) {
|
|
// line formate should be ss=nn
|
|
// ss is always a 2 character integer
|
|
// nn starts at index 3 and can be up to a 5 character unsigned integer
|
|
|
|
//12=12345
|
|
//01234567
|
|
|
|
char setting_val[6];
|
|
char param;
|
|
uint16_t newValue;
|
|
//Serial.print("Read Buffer: "); Serial.println(readBuffer);
|
|
|
|
if (readBuffer[1] != '='){ // check if the equals sign is there
|
|
Serial.print("Missing '=' in command");
|
|
readIndex = 0;
|
|
return;
|
|
}
|
|
|
|
// move the value characters into a char array while verifying they are digits
|
|
for(int i=0; i<5; i++) {
|
|
if (i+2 < readIndex) {
|
|
if (isDigit(readBuffer[i+2]))
|
|
setting_val[i] = readBuffer[i+2];
|
|
else {
|
|
Serial.println("Invalid setting value");
|
|
return;
|
|
}
|
|
}
|
|
else
|
|
setting_val[i] = 0;
|
|
}
|
|
|
|
param = readBuffer[0];
|
|
newValue = atoi(setting_val); // convert the val section to an integer
|
|
|
|
memset(readBuffer,0,sizeof(readBuffer));
|
|
|
|
switch (param) {
|
|
case 'B': // brightness
|
|
if(newValue >= MIN_BRIGHTNESS && newValue <= MAX_BRIGHTNESS) {
|
|
user_settings.led_brightness = (uint8_t)newValue;
|
|
settings_eeprom_write();
|
|
FastLED.setBrightness(user_settings.led_brightness);
|
|
//delay(1000);
|
|
//ESP.restart(); // this one requires a restart right now
|
|
}
|
|
else {
|
|
printError(ERR_SETTING_RANGE);
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case 'S': // sound
|
|
if (newValue >=MIN_VOLUME && newValue <= MAX_VOLUME)
|
|
user_settings.audio_volume = (uint8_t)newValue;
|
|
else {
|
|
printError(ERR_SETTING_RANGE);
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case 'D': // deadzone, joystick
|
|
if(newValue >=MIN_JOYSTICK_DEADZONE && newValue <=MAX_JOYSTICK_DEADZONE)
|
|
user_settings.joystick_deadzone = (uint8_t)newValue;
|
|
else {
|
|
printError(ERR_SETTING_RANGE);
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case 'A': // attack threshold, joystick
|
|
if(newValue >=MIN_ATTACK_THRESHOLD && newValue <=MAX_ATTACK_THRESHOLD)
|
|
user_settings.attack_threshold = (uint16_t)newValue;
|
|
else {
|
|
printError(ERR_SETTING_RANGE);
|
|
return;
|
|
}
|
|
break;
|
|
|
|
case 'L': // lives per level
|
|
if (newValue >= 3 && newValue <= 9)
|
|
user_settings.lives_per_level = (uint8_t)newValue;
|
|
else {
|
|
printError(ERR_SETTING_RANGE);
|
|
return;
|
|
}
|
|
break;
|
|
|
|
default:
|
|
Serial.print("Command Error: ");
|
|
Serial.println(readBuffer[0]);
|
|
return;
|
|
break;
|
|
|
|
}
|
|
|
|
show_settings_menu();
|
|
}
|
|
|
|
void reset_settings() {
|
|
user_settings.settings_version = SETTINGS_VERSION;
|
|
|
|
user_settings.led_brightness = DEFAULT_BRIGHTNESS;
|
|
|
|
user_settings.joystick_deadzone = DEFAULT_JOYSTICK_DEADZONE;
|
|
user_settings.attack_threshold = DEFAULT_ATTACK_THRESHOLD;
|
|
|
|
user_settings.audio_volume = DEFAULT_VOLUME;
|
|
|
|
user_settings.lives_per_level = LIVES_PER_LEVEL;
|
|
|
|
user_settings.games_played = 0;
|
|
user_settings.total_points = 0;
|
|
user_settings.high_score = 0;
|
|
user_settings.boss_kills = 0;
|
|
|
|
settings_eeprom_write();
|
|
}
|
|
|
|
void show_settings_menu() {
|
|
Serial.println("\r\n====== TWANG Settings Menu ========");
|
|
Serial.println("= Current values are shown =");
|
|
Serial.println("= Send new values like B=150 =");
|
|
Serial.println("= with a carriage return =");
|
|
Serial.println("===================================");
|
|
|
|
Serial.print("\r\nB=");
|
|
Serial.print(user_settings.led_brightness);
|
|
Serial.println(" (LED Brightness 5-255..forces restart)");
|
|
|
|
Serial.print("S=");
|
|
Serial.print(user_settings.audio_volume);
|
|
Serial.println(" (Sound Volume 0-10)");
|
|
|
|
Serial.print("D=");
|
|
Serial.print(user_settings.joystick_deadzone);
|
|
Serial.println(" (Joystick Deadzone 3-12)");
|
|
|
|
Serial.print("A=");
|
|
Serial.print(user_settings.attack_threshold);
|
|
Serial.println(" (Attack Sensitivity 20000-35000)");
|
|
|
|
Serial.print("L=");
|
|
Serial.print(user_settings.lives_per_level);
|
|
Serial.println(" (Lives per Level (3-9))");
|
|
|
|
Serial.println("\r\n(Send...)");
|
|
Serial.println(" ? to show current settings");
|
|
Serial.println(" R to reset everything to defaults)");
|
|
Serial.println(" P to reset play statistics)");
|
|
}
|
|
|
|
void show_game_stats()
|
|
{
|
|
Serial.println("\r\n ===== Play statistics ======");
|
|
Serial.print("Games played: ");Serial.println(user_settings.games_played);
|
|
if (user_settings.games_played > 0) {
|
|
Serial.print("Average Score: ");Serial.println(user_settings.total_points / user_settings.games_played);
|
|
}
|
|
Serial.print("High Score: ");Serial.println(user_settings.high_score);
|
|
Serial.print("Boss kills: ");Serial.println(user_settings.boss_kills);
|
|
}
|
|
|
|
void settings_eeprom_read() {
|
|
|
|
EEPROM.begin(EEPROM_SIZE);
|
|
|
|
uint8_t ver = EEPROM.read(0);
|
|
uint8_t temp[sizeof(user_settings)];
|
|
|
|
if (ver != SETTINGS_VERSION) {
|
|
Serial.print("Error: EEPROM settings read failed:"); Serial.println(ver);
|
|
Serial.println("Loading defaults...");
|
|
reset_settings();
|
|
return;
|
|
}
|
|
else {
|
|
Serial.print("Settings version: "); Serial.println(ver);
|
|
}
|
|
|
|
for (int i=0; i<sizeof(user_settings); i++)
|
|
{
|
|
temp[i] = EEPROM.read(i);
|
|
}
|
|
|
|
EEPROM.end();
|
|
|
|
memcpy((char*)&user_settings, temp, sizeof(user_settings));
|
|
|
|
|
|
|
|
}
|
|
|
|
void settings_eeprom_write() {
|
|
|
|
sound_pause(); // prevent interrupt from causing crash
|
|
|
|
EEPROM.begin(EEPROM_SIZE);
|
|
|
|
uint8_t temp[sizeof(user_settings)];
|
|
memcpy(temp, (uint8_t*)&user_settings, sizeof(user_settings));
|
|
|
|
for (int i=0; i<sizeof(user_settings); i++)
|
|
{
|
|
EEPROM.write(i, temp[i]);
|
|
}
|
|
|
|
EEPROM.commit();
|
|
|
|
EEPROM.end();
|
|
|
|
sound_resume(); // restore sound interrupt
|
|
|
|
}
|
|
|
|
void printError(int reason) {
|
|
|
|
switch(reason) {
|
|
case ERR_SETTING_NUM:
|
|
Serial.print("Error: Invalid setting number");
|
|
break;
|
|
case ERR_SETTING_RANGE:
|
|
Serial.print("Error: Setting out of range");
|
|
break;
|
|
default:
|
|
Serial.print("Error:");Serial.println(reason);
|
|
break;
|
|
}
|
|
}
|
|
|
|
#endif
|