Buoyancy Firmware  1.0
Buoyancy Vehicle Firmware Documentation
menu program file

Contain Menu module with related functions. More...

Macros

#define RTC_MAX_COUNT   16777216
 Maximum value of RTC clock. More...
 

Enumerations

enum  menu {
  MAINMENU, MISSIONDATA, CONFIGVEHICLE, TRANSFERDATA,
  TRANSFER_ALL_FILES, TRANSFER_ONE_FILE, DELETE_ALL_FILES, DELETE_ONE_FILE
}
 menu options and operations enumerated. More...
 
enum  fileoption { TRANSFER_ALL, TRANSFER_ONE, DELETE_ALL, DELETE_ONE }
 file operations enumerated. More...
 
enum  config {
  M1DEPTH, M1TIME, M2DEPTH, M2TIME,
  M3DEPTH, M3TIME, M4DEPTH, M4TIME,
  PID_P, PID_I, PID_D, THRESHOLD,
  ATM_PRESSURE
}
 configurable values enumerated. More...
 

Functions

void setConfigValue (char *)
 function for setting configuration value received from BLE client. More...
 
void mainMenu (int option)
 
More...
 
void missinDataMenu (int option)
 
More...
 
void configVehicleMenu (int option)
 
More...
 
void transferDataMenu (int option)
 
More...
 
void transferData (char *fileCmd)
 
More...
 
void printMainMenu ()
 
More...
 
void printMissionDataMenu ()
 
More...
 
void printConfigVehicleMenu ()
 
More...
 
void printTransferDataMenu ()
 
More...
 
void transferAllFiles ()
 
More...
 
void TransferOneFile (void)
 
More...
 
void deleteFile (void)
 
More...
 
void deleteAllFiles (void)
 
More...
 

Detailed Description

Contain Menu module with related functions.

Macro Definition Documentation

◆ RTC_MAX_COUNT

#define RTC_MAX_COUNT   16777216

Maximum value of RTC clock.

Enumeration Type Documentation

◆ config

enum config

configurable values enumerated.

Enumerator
M1DEPTH 

Mission 1 depth.

M1TIME 

Mission 1 time.

M2DEPTH 

Mission 2 depth.

M2TIME 

Mission 2 time.

M3DEPTH 

Mission 3 depth.

M3TIME 

Mission 3 time.

M4DEPTH 

Mission 4 depth.

M4TIME 

Mission 4 time.

PID_P 

Kp coefficient.

PID_I 

Ki coefficient.

PID_D 

Kd coefficient.

THRESHOLD 

Ki threshold.

ATM_PRESSURE 

Atmospheric pressure.

◆ fileoption

enum fileoption

file operations enumerated.

Enumerator
TRANSFER_ALL 
TRANSFER_ONE 
DELETE_ALL 
DELETE_ONE 

◆ menu

enum menu

menu options and operations enumerated.

Enumerator
MAINMENU 
MISSIONDATA 
CONFIGVEHICLE 
TRANSFERDATA 
TRANSFER_ALL_FILES 
TRANSFER_ONE_FILE 
DELETE_ALL_FILES 
DELETE_ONE_FILE 

Function Documentation

◆ configVehicleMenu()

void configVehicleMenu ( int  )

navigate ConfigVehicle menu

params[in] option integer value passed to switch statement to choose the configuration to change

◆ deleteAllFiles()

void deleteAllFiles ( void  )

delte all mission log files from SD card.

◆ deleteFile()

void deleteFile ( void  )

delete one mission log files from SD card.

Client choose a file to delete

◆ mainMenu()

void mainMenu ( int  )

in Main Menu navigate to sub menu.

params[in] option integer value passed to switch statement to chose sub menu

◆ missinDataMenu()

void missinDataMenu ( int  )

navigate Mission Data menu

params[in] option integer value passed to switch statement to choose the configuration to change

◆ printConfigVehicleMenu()

void printConfigVehicleMenu ( )

print Configure Vehicle menu over BLE to client.

◆ printMainMenu()

void printMainMenu ( )

print main menu over BLE to client.

◆ printMissionDataMenu()

void printMissionDataMenu ( )

print Mission Data menu over BLE to client.

◆ printTransferDataMenu()

void printTransferDataMenu ( )

print Trasnfer Data menu over BLE to client.

◆ setConfigValue()

void setConfigValue ( char *  )

function for setting configuration value received from BLE client.

params[in] value received as character, and converted to integer or float depending on the written configuration

◆ transferAllFiles()

void transferAllFiles ( )

Transfer all mission log files from SD card over BLE to client.

<Check for and handle RTC wrap around

◆ transferData()

void transferData ( char *  )

handle file operation menu

params[in] fileCmd converted to integer and passed to switch statement to choose the file option

◆ transferDataMenu()

void transferDataMenu ( int  )

navigate transferData menu

params[in] option integer value passed to switch statement to choose file operation.

◆ TransferOneFile()

void TransferOneFile ( void  )

Transfer one mission log files from SD card over BLE to client.

Client choose a file to transfer

<Check for and handle RTC wrap around

< Elapsed time in seconds