#!/bin/sh
###########################################################################
#
# Copyright (c) 2021-2023 Diality Inc. - All Rights Reserved.
#
# THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
# WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
#
# @file    _errors_
#
# @author  (last)      Behrouz NematiPour
# @date    (last)      15-Jan-2025
# @author  (original)  Behrouz NematiPour
# @date    (original)  15-Jan-2025
#
############################################################################

# Description
#   Definition of all the error ID and Descriptions
# Parameters
#   No specific parameter
# Retruns
#   No specific response
# Considerations 
#   The error IDs shall not be negative
#   The error Messages are assumed as system errors and will not be translated.
#   The error Messages returned by the caller script will only be shown on the Application
#       if only the exit code of the caller script is non-zero.

# TODO
#   - rearrange the Error IDs by group

# sources

# variables
#   0x: General Errors
ERR_GENERAL_SCRIPT_FAIL=1
ERR_GENERAL_SCRIPT_PARAM_COUNT=2
ERR_GENERAL_SCRIPT_EMPTY_STRING=3
ERR_GENERAL_SCRIPT_FILE_EXIST=4

#   1x: Empty parameters
ERR_MTPARAM_WIFI_SSID=10
ERR_MTPARAM_WIFI_PASS=11
ERR_MTPARAM_BRIGHTNESS_VALUE=12
ERR_MTPARAM_USB_DEVICE=13
ERR_MTPARAM_USB_FOLDER=14

#   2x: WiFi Errors 2x
ERR_CMDFAIL_WIFI_SCAN=20
ERR_CMDFAIL_WIFI_CONNECT=21
ERR_CMDFAIL_WIFI_DISCONNECT=22
ERR_CMDFAIL_WIFI_INFO_SSID=23
ERR_CMDFAIL_WIFI_INFO_IPMASK=24
ERR_CMDFAIL_WIFI_INFO_ADDR=25
ERR_CMDFAIL_WIFI_INFO_MASK=26
ERR_CMDFAIL_WIFI_INFO_GATEWAY=27
ERR_CMDFAIL_WIFI_INFO_DNS=28
ERR_CMDFAIL_WIFI_DELETE_CONNECTION=29

#   3x: Brightness Errors 3x
ERR_CMDFAIL_BRIGHTNESS_GET=30
ERR_CMDFAIL_BRIGHTNESS_SET=31

#   4x: USB Device Errors
ERR_CMDFAIL_USB_FOLDER_MAKE=40
ERR_CMDFAIL_USB_DEVICE_MOUNT=41
ERR_CMDFAIL_USB_FOLDER_REMOVE=42
ERR_CMDFAIL_USB_DEVICE_UMOUNT=43

#   5x: Date Time Errors
ERR_CMDFAIL_TIMEDATECTL=50
ERR_CMDFAIL_DATE=51
ERR_CMDFAIL_HW_CLOCK=52

#   6x: Factory Reset Errors
ERR_CMDFAIL_SETTINGS_CONF_PASSNOTFOUND=60
ERR_CMDFAIL_SETTINGS_CONF_OVERWRITE=61
ERR_CMDFAIL_SETTINGS_DFLT_RESTORE=62
ERR_CMDFAIL_SETTINGS_REMOVE_LOG_FOLDER=63
ERR_CMDFAIL_SETTINGS_REMOVE_SERVICE_LOG=64
ERR_CMDFAIL_SETTINGS_COUNT_SERVICE_LOG=65
ERR_CMDFAIL_SETTINGS_REMOVE_TX_LOG=66
ERR_CMDFAIL_SETTINGS_COUNT_TX_LOG=67

#   7x: SSH Access Errors
ERR_CMDFAIL_SSH_SERVICE=70
ERR_CMDFAIL_SSH_STATUS=71
ERR_CMDFAIL_ROOT_LOGIN_ENABLED=72
ERR_CMDFAIL_ROOT_LOGIN_DISABLED=73
ERR_CMDFAIL_ROOT_LOGIN_STATUS=74