ModbusUnitCoilNode.cs

using System;
using System.Collections;
using System.Collections.Generic;
using System.Threading.Tasks;
using Waher.Networking.Modbus;
using Waher.Persistence.Attributes;
using Waher.Runtime.Language;
using Waher.Things.Attributes;
using Waher.Things.ControlParameters;
using Waher.Things.DisplayableParameters;
using Waher.Things.SensorData;
 
namespace Waher.Things.Modbus
{
    public class ModbusUnitCoilNode : ModbusUnitChildNode, ISensor, IActuator
    {
        public ModbusUnitCoilNode()
            : base()
        {
        }
 
        [Page(4, "Modbus", 100)]
        [Header(8, "Coil Number:")]
        [ToolTip(9, "Coil number on the Modbus unit.")]
        [Range(0, 65535)]
        [Required]
        public int CoilNr { get; set; }
 
        [Page(4, "Modbus", 100)]
        [Header(11, "Field Name:")]
        [ToolTip(12, "Custom field name for value.")]
        [DefaultValueStringEmpty]
        public string FieldName { get; set; }
 
        public override Task<string> GetTypeNameAsync(Language Language)
        {
            return Language.GetStringAsync(typeof(ModbusGatewayNode), 3, "Coil (0x)");
        }
 
        public override async Task<IEnumerable<Parameter>> GetDisplayableParametersAsync(Language Language, RequestOrigin Caller)
        {
            LinkedList<Parameter> Result = await base.GetDisplayableParametersAsync(Language, Caller) as LinkedList<Parameter>;
 
            Result.AddLast(new Int32Parameter("Nr", await Language.GetStringAsync(typeof(ModbusGatewayNode), 10, "Nr"), this.CoilNr));
 
            return Result;
        }
 
        public async Task StartReadout(ISensorReadout Request)
        {
            ModbusTcpClient Client = await (await this.GetGateway()).GetTcpIpConnection();
            await Client.Enter();
            try
            {
                BitArray Bits = await Client.ReadCoils((byte)(await this.GetUnitNode()).UnitId, (ushort)this.CoilNr, 1);
 
                await Request.ReportFields(true, new BooleanField(await this.GetReportAs(), DateTime.UtcNow, this.GetFieldName(), Bits[0], FieldType.Momentary, FieldQoS.AutomaticReadout, true));
            }
            catch (Exception ex)
            {
                await Request.ReportErrors(true, new ThingError(this, ex.Message));
            }
            finally
            {
                await Client.Leave();
            }
        }
 
        public string GetFieldName()
        {
            if (string.IsNullOrEmpty(this.FieldName))
                return "Value";
            else
                return this.FieldName;
        }
 
        public Task<ControlParameter[]> GetControlParameters()
        {
            return Task.FromResult(new ControlParameter[]
            {
                new BooleanControlParameter("Value", "Modbus", this.GetFieldName(), "Coil output",
                    async (Node) =>
                    {
                        ModbusTcpClient Client = await (await this.GetGateway()).GetTcpIpConnection();
                        await Client.Enter();
                        try
                        {
                            BitArray Bits = await Client.ReadCoils((byte)(await this.GetUnitNode()).UnitId, (ushort)this.CoilNr, 1);
                            return Bits[0];
                        }
                        finally
                        {
                            await Client.Leave();
                        }
                    },
                    async (Node, Value) =>
                    {
                        ModbusTcpClient Client = await (await this.GetGateway()).GetTcpIpConnection();
                        await Client.Enter();
                        try
                        {
                            bool WritenValue = await Client.WriteCoil((byte)(await this.GetUnitNode()).UnitId, (ushort)this.CoilNr, Value);
 
                            if (WritenValue != Value)
                                throw new Exception("Coil value not changed.");
                        }
                        finally
                        {
                            await Client.Leave();
                        }
                    })
            });
        }
    }
}