messages.h

/*
  messages.h - system messages

  Part of grblHAL

  Copyright (c) 2017-2021 Terje Io
  Copyright (c) 2014-2016 Sungeun K. Jeon for Gnea Research LLC

  Grbl is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  Grbl is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with Grbl.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _MESSAGES_H_
#define _MESSAGES_H_

// Define feedback message codes. Valid values (0-255).
typedef enum {
    Message_None = 0,                       //!< 0 - reserved, do not change value.
    Message_CriticalEvent = 1,              //!< 1
    Message_AlarmLock = 2,                  //!< 2
    Message_AlarmUnlock = 3,                //!< 3
    Message_Enabled = 4,                    //!< 4
    Message_Disabled = 5,                   //!< 5
    Message_SafetyDoorAjar = 6,             //!< 6
    Message_CheckLimits = 7,                //!< 7
    Message_ProgramEnd = 8,                 //!< 8
    Message_RestoreDefaults = 9,            //!< 9
    Message_SpindleRestore = 10,            //!< 10
    Message_SleepMode = 11,                 //!< 11
    Message_EStop = 12,                     //!< 12
    Message_HomingCycleRequired = 13,       //!< 13
    Message_CycleStartToRerun = 14,         //!< 14
    Message_ReferenceTLOEstablished = 15,   //!< 15
    Message_MotorFault = 16,                //!< 16
    Message_NextMessage                     //!< 17 - next unassigned message number.
} message_code_t;

typedef struct {
    message_code_t id;
    const char *msg;
} message_t;

PROGMEM static const message_t messages[] = {
    { .id = Message_None, .msg = "" },
    { .id = Message_CriticalEvent, .msg = "Reset to continue" },
    { .id = Message_AlarmLock, .msg = "'$H'|'$X' to unlock" },
    { .id = Message_AlarmUnlock, .msg = "Caution: Unlocked" },
    { .id = Message_Enabled, .msg = "Enabled" },
    { .id = Message_Disabled, .msg = "Disabled" },
    { .id = Message_SafetyDoorAjar, .msg = "Check Door" },
    { .id = Message_CheckLimits, .msg = "Check Limits" },
    { .id = Message_ProgramEnd, .msg = "Pgm End" },
    { .id = Message_RestoreDefaults, .msg = "Restoring defaults" },
    { .id = Message_SpindleRestore, .msg = "Restoring spindle" },
    { .id = Message_SleepMode, .msg = "Sleeping" },
    { .id = Message_EStop, .msg = "Emergency stop" },
    { .id = Message_HomingCycleRequired, .msg = "Homing cycle required" },
    { .id = Message_CycleStartToRerun, .msg = "Press cycle start to rerun job" },
    { .id = Message_ReferenceTLOEstablished, .msg = "Reference tool length offset established" },
    { .id = Message_MotorFault, .msg = "Motor fault" }
};

#endif