Electropepper/NMM-1
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Finished commenting v01 code, updated schematic to new Kicad 5 version.

Browse Source
This commit is contained in:
Ricardo
2018-11-20 12:27:42 +00:00
parent 6bb83c7b8d
commit aabcbba93b
16 changed files with 5495 additions and 647 deletions
Download Patch File Download Diff File Expand all files Collapse all files

578
firmware/v01/v01.ino
View File

@@ -1,5 +1,4 @@
/*********************************************************************
NMM-1
NMEA0183 serial Monitor.
@@ -15,7 +14,7 @@ Wed 24 Jan 23:11:25 GMT 2018
#include <Adafruit_SSD1306.h>
#define OLED_RESET 8
Adafruit_SSD1306 display(OLED_RESET);
Adafruit_SSD1306 display(OLED_RESET); // Create display object for OLED display
#define ON 0 // ON means pin is on GND
#define OFF 1 // OFF means pin is on VCC
@@ -38,7 +37,7 @@ Adafruit_SSD1306 display(OLED_RESET);
// Function declarations
void one(); // Menu one
void two(); // Menu two
void two(); // Menu two
void three(); // Menu three
void four(); // Menu four
void read_serial(); // Menu that reads the serial
@@ -46,7 +45,6 @@ void write_gps(); // Menu that writes gps out to serial
void write_hdg(); // Menu that writes hdg out to serial
void write_dep(); // Menu that writes dep out to serial
void batt_icon(); // Draws the battery icon acording to value
void write_serial(); // Menu that writes to serial
@@ -59,14 +57,13 @@ int OK_state = OFF; // Holds state for OK, either ON or OFF
int DOWN_state = OFF; // Holds state for DOWN, either ON or OFF
int CANCEL_state = OFF; // Holds state for CANCEL, either ON or OFF
int batt_val = 0; // Holds the value of battery voltage
int incomingByte; // Serial incoming byte buffer
int read_s = 0;
int read_s = 0; // Serial flag, if 0 not reading, if 1 is reading
// Create SoftwareSerial object and designate pins
SoftwareSerial mySerial(6, 7); // RX, TX
void setup() { // BEGIN SETUP ------------------------------------
void setup() { // BEGIN SETUP ------------------------------------
pinMode(led1, OUTPUT); // Led 1 is an output
@@ -79,18 +76,16 @@ void setup() { // BEGIN SETUP ------------------------------------
// Define the starting state of the led's
digitalWrite(led1,HIGH); // Turn off led 1
digitalWrite(led2,HIGH); // Turn off led 2
// set the data rate for the SoftwareSerial port
// set the data rate for the Serial port
Serial.begin(4800);
// by default, we'll generate the high voltage from the 3.3v line internally! (neat!)
display.begin(SSD1306_SWITCHCAPVCC, 0x3C); // initialize with the I2C addr 0x3C (for the 128x32)
// init done
// initialize timer1 ---------------------------------------
// initialize timer1 ---------------------------------------
noInterrupts(); // disable all interrupts
TCCR1A = 0;
TCCR1B = 0;
@@ -98,7 +93,7 @@ void setup() { // BEGIN SETUP ------------------------------------
OCR1A = 9000; // Load value to compare
TCCR1B |= (1 << WGM12); // CTC mode
TCCR1B |= (1 << CS10); // 64 prescaler
TCCR1B |= (1 << CS10); // 64 prescaler
TCCR1B |= (1 << CS11); //
TIMSK1 |= (1 << OCIE1A); // enable timer compare interrupt
interrupts(); // enable all interrupts
@@ -106,338 +101,383 @@ void setup() { // BEGIN SETUP ------------------------------------
// Clear the buffer.
display.clearDisplay();
display.display();
display.setTextSize(2);
display.setTextColor(WHITE);
display.setCursor(36,22);
display.println("NMM-1");
display.display();
display.clearDisplay(); // Clean display
display.display(); // Refresh display
display.setTextSize(2); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(36,22); // Set the display cursor to position
display.println("NMM-1"); // Print on display
display.display(); // Refresh display
delay(3000);
display.clearDisplay();
display.display();
display.clearDisplay(); // Clean display
display.display(); // Refresh display
} // END SETUP --------------------------------------------------------------------
// Timer compare interrupt service routine --------------------------
ISR(TIMER1_COMPA_vect) //
{ //
if (!rUP) {
if (menuState == 1) {
menuState = 1;
ISR(TIMER1_COMPA_vect)
{
if (!rUP) // If button UP pressed
{
if (menuState == 1) // and the menuState is 1
{
menuState = 1; // then reset menuState to 1
}
else if (menuState == 2) {
menuState = 1;
else if (menuState == 2) // If menuState is 2
{
menuState = 1; // then reset menuState to 1
}
else if (menuState == 3) {
menuState = 2;
else if (menuState == 3) // If menuState is 3
{
menuState = 2; // then reset menuState to 2
}
else if (menuState == 4) {
menuState = 3;
else if (menuState == 4) // If menuState is 4
{
menuState = 3; // then reset menuState to 3
}
while (!rUP); // Check if button is still pressed do nothing
}
if (!rDOWN) {
if (menuState == 1) {
menuState = 2;
if (!rDOWN) // If button DOWN pressed
{
if (menuState == 1) // and the menuState is 1
{
menuState = 2; // then reset menuState to 2
}
else if (menuState == 2) {
menuState = 3;
else if (menuState == 2) // If menuState is 2
{
menuState = 3; // then reset menuState to 3
}
else if (menuState == 3) {
menuState = 4;
else if (menuState == 3) // If menuState is 3
{
menuState = 4; // then reset menuState to 4
}
else if (menuState == 4) {
menuState = 4;
else if (menuState == 4) // If menuState is 4
{
menuState = 4; // then reset menuState to 4
}
while (!rDOWN); // Check if button is still pressed do nothing
}
if (!rOK) {
if (menuState == 1) {
menuState = 10;
prevMenu = 1;
}
else if (menuState == 2) {
menuState = 11;
prevMenu = 2;
if (!rOK) // If button OK pressed
{
if (menuState == 1) // and the menuState is 1
{
menuState = 10; // then reset menuState to 10
prevMenu = 1; // and set prevMenu to 1
}
else if (menuState == 3) {
menuState = 12;
prevMenu = 3;
else if (menuState == 2) // If menuState is 2
{
menuState = 11; // then reset menuState to 11
prevMenu = 2; // and set prevMenu to 2
}
else if (menuState == 4) {
menuState = 13;
prevMenu = 4;
else if (menuState == 3) // If menuState is 3
{
menuState = 12; // then reset menuState to 12
prevMenu = 3; // and set prevMenu to 3
}
else if (menuState == 4) // If menuState is 4
{
menuState = 13; // then reset menuState to 13
prevMenu = 4; // and set prevMenu to 4
}
while (!rOK); // Check if button is still pressed do nothing
}
}
if (!rCANCEL) {
if (prevMenu == 1) {
menuState = 1;
if (!rCANCEL) { // If button OK pressed
{
if (prevMenu == 1) // and the prevMenu is 1
{
menuState = 1; // then reset menuState to 1
}
else if (prevMenu == 2) {
menuState = 2;
else if (prevMenu == 2) // If prevMenu is 2
{
menuState = 2; // then reset menuState to 2
}
else if (prevMenu == 3) {
menuState = 3;
else if (prevMenu == 3) // If prevMenu is 3
{
menuState = 3; // then reset menuState to 3
}
else if (prevMenu == 4) {
menuState = 4;
else if (prevMenu == 4) // If prevMenu is 4
{
menuState = 4; // then reset menuState to 4
}
while (!rCANCEL); // Check if button is still pressed do nothing
}
}
}
// -------------------------------------------------------------------
// End of Timer compare interrupt ---------------------------------------
// Main loop routine -----------------------------------------
void loop()
{
void loop() {
batt_val = analogRead(batt); // Read analog value from battery into batt_val
batt_val = analogRead(batt);
if (menuState == 1) {
one();
mySerial.end();
read_s = 0;
}
else if (menuState == 2) {
two();
mySerial.end();
read_s = 0;
}
else if (menuState == 3) {
three();
mySerial.end();
read_s = 0;
}
else if (menuState == 4) {
four();
mySerial.end();
read_s = 0;
}
else if (menuState == 10) {
if (read_s == 0) {
mySerial.begin(4800);
read_s = 1;
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,17);
display.println("Sending GPS.....");
batt_icon();
display.display();
if (menuState == 1) // If menuState is 1
{
one(); // call function one()
mySerial.end(); // close serial connection
read_s = 0; // and set read_s to 0
}
write_gps();
}
else if (menuState == 11) {
if (read_s == 0) {
mySerial.begin(4800);
read_s = 1;
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,17);
display.println("Sending Heading.....");
batt_icon();
display.display();
else if (menuState == 2) // If menuState is 2
{
two(); // call function two()
mySerial.end(); // close serial connection
read_s = 0; // and set read_s to 0
}
write_hdg();
}
else if (menuState == 12) {
if (read_s == 0) {
mySerial.begin(4800);
read_s = 1;
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,17);
display.println("Sending Depth.....");
batt_icon();
display.display();
else if (menuState == 3) // If menuState is 3
{
three(); // call function three()
mySerial.end(); // close serial connection
read_s = 0; // and set read_s to 0
}
write_dep();
}
else if (menuState == 13) {
if (read_s == 0) {
mySerial.begin(4800);
read_s = 1;
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,17);
display.println("RS-422 to USB");
display.println("Sending...");
batt_icon();
display.display();
else if (menuState == 4) // If menuState is 4
{
four(); // call function four()
mySerial.end(); // close serial connection
read_s = 0; // and set read_s to 0
}
else if (menuState == 10) // If menuState is 10
{
if (read_s == 0) // and read_s is 0
{
mySerial.begin(4800); // Start serial with 4800bps
read_s = 1; // set read_s to 1
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,17); // Set the display cursor to position
display.println("Sending GPS....."); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
write_gps(); // call function write_gps()
}
else if (menuState == 11) // If menuState is 11
{
if (read_s == 0) // and read_s is 0
{
mySerial.begin(4800); // Start serial with 4800bps
read_s = 1; // set read_s to 1
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,17); // Set the display cursor to position
display.println("Sending Heading....."); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
write_hdg(); // call function write_hdg()
}
else if (menuState == 12) // If menuState is 12
{
if (read_s == 0) // and read_s is 0
{
mySerial.begin(4800); // Start serial with 4800bps
read_s = 1; // set read_s to 1
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,17); // Set the display cursor to position
display.println("Sending Depth....."); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
write_dep(); // call function write_dep()
}
else if (menuState == 13) // If menuState is 13
{
if (read_s == 0) // and read_s is 0
{
mySerial.begin(4800); // Start serial with 4800bps
read_s = 1; // set read_s to 1
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,17); // Set the display cursor to position
display.println("RS-422 to USB"); // Print on display
display.println("Sending..."); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
read_serial(); // call function read_serial()
}
else // otherwise
{
one(); // call function one()
mySerial.end(); // close serial connection
read_s = 0; // set read_s to 0
}
read_serial();
}
else {
one();
mySerial.end();
read_s = 0;
}
}
// END of Main loop routine -----------------------------------------
void batt_icon (void) {
void batt_icon (void)
{
if (batt_val > 962) {
// Draw the battery icon - Full battery
display.drawRect(111, 1, 16, 6, WHITE);
display.drawRect(112, 2, 14, 4, WHITE);
display.drawRect(113, 3, 12, 2, WHITE);
display.drawPixel(110, 3, WHITE);
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
if (batt_val > 962) // If analog value is bigger then 962
{
// Draw the battery icon - Full battery
display.drawRect(111, 1, 16, 6, WHITE); // Draw white reactangle with coordinates
display.drawRect(112, 2, 14, 4, WHITE);
display.drawRect(113, 3, 12, 2, WHITE);
display.drawPixel(110, 3, WHITE); // Draw white dot with coordinates
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
}
else if ((batt_val > 901) & (batt_val < 962)) {
// Draw the battery icon - 2/3 battery
display.drawRect(111, 1, 16, 6, WHITE);
display.drawRect(116, 2, 10, 4, WHITE);
display.drawRect(117, 3, 8, 2, WHITE);
display.drawPixel(110, 3, WHITE);
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
else if ((batt_val > 901) & (batt_val < 962)) // If analog value is between 901 and 962
{
// Draw the battery icon - 2/3 battery
display.drawRect(111, 1, 16, 6, WHITE); // Draw white reactangle with coordinates
display.drawRect(116, 2, 10, 4, WHITE);
display.drawRect(117, 3, 8, 2, WHITE);
display.drawPixel(110, 3, WHITE); // Draw white dot with coordinates
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
}
else if ((batt_val > 840) & (batt_val < 901)) {
else if ((batt_val > 840) & (batt_val < 901)) // If analog value is between 840 and 901
{
// Draw the battery icon - 1/3 battery
display.drawRect(111, 1, 16, 6, WHITE);
display.drawRect(121, 2, 5, 4, WHITE);
display.drawRect(122, 3, 3, 2, WHITE);
display.drawPixel(110, 3, WHITE);
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
display.drawRect(111, 1, 16, 6, WHITE); // Draw white reactangle with coordinates
display.drawRect(121, 2, 5, 4, WHITE);
display.drawRect(122, 3, 3, 2, WHITE);
display.drawPixel(110, 3, WHITE); // Draw white dot with coordinates
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
}
else {
// Draw the battery icon - Empty battery
display.setCursor(35,1);
display.println("BATT LOW");
display.drawRect(111, 1, 16, 6, WHITE);
display.drawPixel(110, 3, WHITE);
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
else // otherwise
{
// Draw the battery icon - Empty battery
display.setCursor(35,1); // Set the display cursor to position
display.println("BATT LOW"); // Print on display
display.drawRect(111, 1, 16, 6, WHITE); // Draw white reactangle with coordinates
display.drawPixel(110, 3, WHITE); // Draw white dot with coordinates
display.drawPixel(110, 4, WHITE);
display.drawPixel(109, 3, WHITE);
display.drawPixel(109, 4, WHITE);
display.drawPixel(108, 3, WHITE);
display.drawPixel(108, 4, WHITE);
}
}
void one (void) {
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,22);
display.println("Send GPS <--");
display.setCursor(1,32);
display.println("Send Heading");
display.setCursor(1,42);
display.println("Send Depth");
display.setCursor(1,52);
display.println("RS422 ==> USB");
batt_icon();
display.display();
void one (void)
{
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,22); // Set the display cursor to position
display.println("Send GPS <--"); // Print on display
display.setCursor(1,32); // Set the display cursor to position
display.println("Send Heading"); // Print on display
display.setCursor(1,42); // Set the display cursor to position
display.println("Send Depth"); // Print on display
display.setCursor(1,52); // Set the display cursor to position
display.println("RS422 ==> USB"); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
void two (void) {
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,22);
display.println("Send GPS");
display.setCursor(1,32);
display.println("Send Heading <--");
display.setCursor(1,42);
display.println("Send Depth");
display.setCursor(1,52);
display.println("RS422 ==> USB");
batt_icon();
display.display();
void two (void)
{
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,22); // Set the display cursor to position
display.println("Send GPS"); // Print on display
display.setCursor(1,32); // Set the display cursor to position
display.println("Send Heading <--"); // Print on display
display.setCursor(1,42); // Set the display cursor to position
display.println("Send Depth"); // Print on display
display.setCursor(1,52); // Set the display cursor to position
display.println("RS422 ==> USB"); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
void three (void) {
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,22);
display.println("Send GPS");
display.setCursor(1,32);
display.println("Send Heading");
display.setCursor(1,42);
display.println("Send Depth <--");
display.setCursor(1,52);
display.println("RS422 ==> USB");
batt_icon();
display.display();
void three (void)
{
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,22); // Set the display cursor to position
display.println("Send GPS"); // Print on display
display.setCursor(1,32); // Set the display cursor to position
display.println("Send Heading"); // Print on display
display.setCursor(1,42); // Set the display cursor to position
display.println("Send Depth <--"); // Print on display
display.setCursor(1,52); // Set the display cursor to position
display.println("RS422 ==> USB"); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
void four (void) {
display.clearDisplay();
display.setTextSize(1);
display.setTextColor(WHITE);
display.setCursor(1,22);
display.println("Send GPS");
display.setCursor(1,32);
display.println("Send Heading");
display.setCursor(1,42);
display.println("Send Depth");
display.setCursor(1,52);
display.println("RS422 ==> USB <--");
batt_icon();
display.display();
void four (void)
{
display.clearDisplay(); // Clean display
display.setTextSize(1); // Set text size on the display
display.setTextColor(WHITE); // Set text color on the display
display.setCursor(1,22); // Set the display cursor to position
display.println("Send GPS"); // Print on display
display.setCursor(1,32); // Set the display cursor to position
display.println("Send Heading"); // Print on display
display.setCursor(1,42); // Set the display cursor to position
display.println("Send Depth"); // Print on display
display.setCursor(1,52); // Set the display cursor to position
display.println("RS422 ==> USB <--"); // Print on display
batt_icon(); // call function batt_icon()
display.display(); // Refresh display
}
void read_serial (void) {
if (mySerial.available()) {
Serial.write(mySerial.read());
void read_serial (void)
{
if (mySerial.available()) // If incoming NMEA0183 serial
{
Serial.write(mySerial.read()); // redirect it to USB
}
}
void write_gps (void) {
void write_gps (void)
{
// Write NMEA0183 GPS sentence to USB
mySerial.print("$GPGGA,090000.10,6350.37829338,N,02225.18272240,W,1,05,2.87,160.00,M,-21.3213,M,,*64");
mySerial.println();
mySerial.println(); // Print on display
delay(100);
}
void write_hdg (void) {
void write_hdg (void)
{
// Write NMEA0183 Heading sentence to USB
mySerial.print("$HEHDT,268.4,T*27");
mySerial.println();
mySerial.println(); // Print on display
delay(100);
}
void write_dep (void) {
void write_dep (void)
{
// Write NMEA0183 Depth sentence to USB
mySerial.print("$SDDBT,0038.0,f,0011.6,M,0006.3,F");
mySerial.println();
mySerial.println(); // Print on display
delay(100);
}