Lcd1602.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Device.Gpio;
using System.Device.I2c;
using SixLabors.ImageSharp;

namespace Iot.Device.CharacterLcd
{
    /// <summary>
    /// 16x2 HD44780 compatible character LCD display.
    /// </summary>
    public class Lcd1602 : Hd44780
    {
        /// <summary>
        /// Constructs a new HD44780 based 16x2 LCD controller, using GPIO pins.
        /// </summary>
        /// <param name="registerSelectPin">The pin that controls the regsiter select.</param>
        /// <param name="enablePin">The pin that controls the enable switch.</param>
        /// <param name="dataPins">Collection of pins holding the data that will be printed on the screen.</param>
        /// <param name="backlightPin">The optional pin that controls the backlight of the display.</param>
        /// <param name="backlightBrightness">The brightness of the backlight. 0.0 for off, 1.0 for on.</param>
        /// <param name="readWritePin">The optional pin that controls the read and write switch.</param>
        /// <param name="controller">The controller to use with the LCD. If not specified, uses the platform default.</param>
        /// <param name="shouldDispose">True to dispose the Gpio Controller</param>
        public Lcd1602(int registerSelectPin, int enablePin, int[] dataPins, int backlightPin = -1, float backlightBrightness = 1.0f, int readWritePin = -1, GpioController? controller = null, bool shouldDispose = true)
            : base(new Size(16, 2), LcdInterface.CreateGpio(registerSelectPin, enablePin, dataPins, backlightPin, backlightBrightness, readWritePin, controller, shouldDispose))
        {
        }

        /// <summary>
        /// Constructs a new HD44780 based 16x2 LCD controller with integrated I2c support.
        /// </summary>
        /// <remarks>
        /// This is for on-chip I2c support. For connecting via I2c GPIO expanders, use the GPIO constructor <see cref="Lcd1602(int, int, int[], int, float, int, GpioController, bool)"/>.
        /// </remarks>
        /// <param name="device">The I2c device for the LCD.</param>
        /// <param name="uses8Bit">True if the device uses 8 Bit commands, false if it handles only 4 bit commands.</param>
        public Lcd1602(I2cDevice device, bool uses8Bit = true)
            : base(new Size(16, 2), LcdInterface.CreateI2c(device, uses8Bit))
        {
        }

        /// <summary>
        /// Constructs a new 16x2 LCD controller with the given interface
        /// </summary>
        /// <param name="lcdInterface">The LCD Interface</param>
        public Lcd1602(LcdInterface lcdInterface)
            : base(new Size(16, 2), lcdInterface)
        {
        }
    }
}