/********************************************
*                 IOwrite.cs                *
********************************************/
/*******************************************************************************************************************************************************
*    All Project Files Copyright © 2025 by The ep5 Educational Broadcasting Foundation                                                                 *
*                                                                                                                                                      *
*    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:    *
*                                                                                                                                                      *
*        →  Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer:              *
*        →  Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the     *
*           documentation and/or other materials provided with the distribution.                                                                       *
*        →  Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this    *
*           software without specific prior written permission.                                                                                        *
*                                                                                                                                                      *
*    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED     *
*    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO  EVENT SHALL THE COPYRIGHT HOLDER OR     *
*    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,         *
*    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF         *
*    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT, INCLUDING NEGLIGENCE OR OTHERWISE, ARISING IN ANY WAY OUT OF THE USE OF THIS           *
*    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                                                                                      *
*******************************************************************************************************************************************************/

//  Written/updated 21 December 2025 by David Fisher
//  Copyright © 2025 by The ep5 Educational Broadcasting Foundation; all rights reserved

/****************************************************************************************************
 *                                                                                                  *
 *     This code is specific to the I/O hardware and its driver.                                    *
 *                                                                                                  *
 ***************************************************************************************************/

using Modbus.Device;
using static System.Console;

namespace TaskScheduler
{
    internal class IOwrite
    {
        // write the values in the machine-state struct to the I/O hardware
        /// <summary>
        ///     This function writes all discrete outputs to the Modbus server. It uses the Modbus starting address and the machine-state values
        ///     of the digital output channels. If an error occurs during the write operation, it catches the exception and returns the appropriate
        ///     failure code.
        /// </summary>
        /// <param name="modbusMaster">This is the function that provides Ethernet connectivity to the fieldbus coupler.</param>
        /// <returns>The appropriate failureCode value.</returns>
        public static int WriteAllDigitalOutputs(ModbusIpMaster modbusMaster)
        {
            try
            {
                modbusMaster.WriteMultipleCoils(Data.coilOutputStartAddress, MachineState.digitalOutputChannels);
            }
            catch (Exception ex)
            {
                WriteLine($"Error writing discrete outputs: {ex.Message}");
                WriteLine("You know the drill; press the <ANY> key to continue...");
                _ = ReadKey(true);
                return Data.failureCode[1];
            }
            return Data.failureCode[0];
        }
    }
}
