###########################################################################
#
# Copyright (c) 2022-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    hd_nvm_scripts.py
#
# @author  (last)      Dara Navaei
# @date    (last)      28-Aug-2023
# @author  (original)  Dara Navaei
# @date    (original)  10-Feb-2022
#
############################################################################
from dialin import HD
from time import sleep


def run_sw_configs_commands():
    # NOTE: For further details, please refer to 'Instructions to Change the Software Configurations Dynamically' in
    # the development section of the DevOps OneNote file

    # Comment and un-comment any of the functions that you would like to use or you can use your own scripts.

    # Use cmd_get_hd_sw_config_record() to get the software configurations record in an excel
    # This function gets an address to locate the report there (i.e. /home/fw/projects/)
    # It creates a folder called HD_NV_Records in the destination that is called
    # If no address is provided, the default location is one folder above the dialin folder wherever it is installed
    # in your computer.
    #hd.sw_configs.cmd_get_hd_sw_config_record()

    # Use cmd_update_hd_sw_config_record() set the changes back to firmware
    # This function requires an address for the excel report. Use the absolute address of your excel report like the
    # example below
    hd.sw_configs.cmd_update_hd_sw_config_record('/home/fw/projects/HD_NV_Records/2023-06-12-HD-SW-CONFIGS-Record.xlsx')

    # Use this function to reset the configuration records to all be 0
    #hd.sw_configs.cmd_reset_hd_sw_config_record()


def run_calibration_commands():
    # NOTE: For further details, please refer to 'Instructions to Calibrate a Device Using the Calibration Report'
    # in the development section of the DevOps OneNote file

    # Comment and un-comment any of the functions that you would like to use or you can use your own scripts.

    # Use cmd_get_dg_calibration_record_report() to get the calibration record in an excel
    # This function gets an address to locate the report there (i.e. /home/fw/projects/)
    # It creates a folder called HD_NV_Records in the destination that is called
    # If no address is provided, the default location is one folder above the dialin folder wherever it is installed
    # in your computer.
    hd.calibration_record.cmd_get_hd_calibration_record_report()

    # Use cmd_set_hd_calibration_excel_to_fw() set the changes back to firmware
    # This function requires an address for the excel report. Use the absolute address of your excel report like the
    # example below
    #hd.calibration_record.cmd_set_hd_calibration_excel_to_fw('/home/fw/projects/HD_NV_Records/2023-08-26-HD-Record.xlsx')

    # For resetting the calibration record to benign values, use the function below
    #hd.calibration_record.cmd_reset_hd_calibration_record()


def run_system_commands():
    # Comment and un-comment any of the functions that you would like to use or you can use your own scripts.

    # Use cmd_get_dg_system_record_report() to get the system record in an excel
    # This function gets an address to locate the report there (i.e. /home/fw/projects/)
    # It creates a folder called DG_NV_Records in the destination that is called
    # If no address is provided, the default location is one folder above the dialin folder wherever it is installed
    # in your computer.
    #hd.system_record.cmd_get_hd_system_record_report()

    hd.system_record.cmd_set_hd_system_record_excel_to_fw('/home/fw/projects/HD_NV_Records/2023-08-25-HD-Record.xlsx')

    # For resetting the system record to benign values, use the function below
    #hd.system_record.cmd_reset_hd_system_record()


def run_usage_info_commands():
    # Comment and un-comment any of the functions that you would like to use or you can use your own scripts.

    # Use cmd_get_dg_system_record_report() to get the system record in an excel
    # This function gets an address to locate the report there (i.e. /home/fw/projects/)
    # It creates a folder called DG_NV_Records in the destination that is called
    # If no address is provided, the default location is one folder above the dialin folder wherever it is installed
    # in your computer.
    #hd.usage_record.cmd_get_hd_usage_info_record()

    hd.usage_record.cmd_set_dg_usage_info_excel_to_fw('/home/fw/projects/HD_NV_Records/2022-12-07-HD-Record.xlsx')

    #hd.usage_record.cmd_reset_hd_usage_info_record()


def run_service_commands():
    # Comment and un-comment any of the functions that you would like to use or you can use your own scripts.

    # Use cmd_get_dg_system_record_report() to get the system record in an excel
    # This function gets an address to locate the report there (i.e. /home/fw/projects/)
    # It creates a folder called DG_NV_Records in the destination that is called
    # If no address is provided, the default location is one folder above the dialin folder wherever it is installed
    # in your computer.
    hd.service_record.cmd_get_hd_service_record()

    #hd.service_record.cmd_set_dg_service_record_excel_to_fw('/home/fw/projects/HD_NV_Records/2022-12-07-HD-Record.xlsx')

    #hd.service_record.cmd_reset_hd_service_record()


if __name__ == "__main__":

    hd = HD(log_level="DEBUG")

    if hd.cmd_log_in_to_hd():

        # Comment this function if not needed
        #run_sw_configs_commands()

        # Comment this function if not needed
        run_calibration_commands()

        #run_system_commands()

        #run_usage_info_commands()

        #run_service_commands()