Sk6812.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.Spi;

namespace Iot.Device.Ws28xx
{
    /// <summary>
    /// Represents the SK6812 Driver.
    /// </summary>
    /// <seealso cref="Iot.Device.Ws28xx.Ws28xx" />
    public class Sk6812 : Ws28xx
    {
        /// <summary>
        /// Gets the default SPI clock frequency.
        /// </summary>
        /// <value>
        /// The default SPI clock frequency used for SK6812-LED-Strips.
        /// </value>
        /// <remarks>This frequency defines how fast the data will be put on the line. The SK6812-strip requires a speed of 1.25 kHz.
        /// A single byte takes 1.2 µs for the transfer, the value for a single LED of 32 bit amounts to 38.4 µs.
        /// </remarks>
        public static int DefaultSpiClockFrequency => 2_400_000;

        /// <summary>
        /// Initializes a new instance of the <see cref="Sk6812"/> class.
        /// </summary>
        /// <param name="spiDevice">The spi device.</param>
        /// <param name="width">The width.</param>
        /// <param name="height">The height.</param>
        public Sk6812(SpiDevice spiDevice, int width, int height = 1)
            : base(spiDevice, new BitmapImageNeo4(width, height))
        {
        }
    }
}