Module ucgd.drivers.glcd
Package com.ibasco.ucgdisplay.drivers.glcd

Class GlcdOption<T>

  • Type Parameters:
    T - The type of the underlying option
    public class GlcdOption<T>
extends java.lang.Object
    Options for the native layer
    Author:
    Rafael Ibasco

    • Field Detail

      • PROVIDER

        public static final GlcdOption<Provider> PROVIDER
        The default provider to be used for all I/O peripherals

      • BUS_SPEED

        public static final GlcdOption<java.lang.Integer> BUS_SPEED
        The transfer rate to be applied for the I/O peripheral (e.g. SPI interface).

        ex: Use 100000 for 100,000 Hz

      • SPI_CHANNEL

        public static final GlcdOption<SpiChannel> SPI_CHANNEL
        The SPI channel (also known as Chip-Select)

        Note: This is only required if the provider is pigpio and Hardware SPI is selected.

        Raspberry Pi SPI Channels

             _____________________________________
    |             CE0    CE1    CE2      |
    | -----------------------------------|
    | Main SPI    8      7       -       |
    | Aux SPI     18     17      16      |
    `````````````````````````````````````
        See Also:
        SPI Channel

      • SPI_BUS

        public static final GlcdOption<SpiBus> SPI_BUS
        The primary bus to be used for SPI communication. For raspberry pi, there are two SPI peripherals available, the main and the auxillary.

      • SPI_MODE

        public static final GlcdOption<SpiMode> SPI_MODE
        The SPI Mode. Values can be 0, 1, 2, or 3. (Default: 0)
        WARNING: On pigpio, modes 1 and 3 do not appear to work on the auxiliary SPI.
        See Also:
        SpiMode

      • SPI_BIT_ORDER

        public static final GlcdOption<SpiBitOrder> SPI_BIT_ORDER
        SPI Bit Order. Can be either 0 = MSB First or 1 = LSB First. (Default: 0)

      • SPI_BITS_PER_WORD

        public static final GlcdOption<java.lang.Integer> SPI_BITS_PER_WORD
        SPI Bits per word. (Default: 8)

      • I2C_BUS

        public static final GlcdOption<I2CBus> I2C_BUS
        The primary bus to be used for I2C communication

        Note: This is only required if you choose pigpio as your I2C provider and the I/O implementation is Hardware.

      • I2C_DEVICE_ADDRESS

        public static final GlcdOption<java.lang.Integer> I2C_DEVICE_ADDRESS
        The I2C address of the display

      • I2C_FLAGS

        public static final GlcdOption<java.lang.Integer> I2C_FLAGS
        Provider specific I2C flags. Only for advanced users. More information on the provider's website.

      • PIGPIO_ADDRESS

        public static final GlcdOption<java.lang.String> PIGPIO_ADDRESS
        The IP address of the pigpiod daemon. If null/empty, the default value would be used (Default: localhost).

        Note: The default value can also be overriden by an environment variable on the target's OS (PIGPIO_ADDR)

      • PIGPIO_PORT

        public static final GlcdOption<java.lang.Integer> PIGPIO_PORT
        The port number of the pigpiod daemon. If null/empty, the default value would be used (Default: 8888).

        Note: The default value can also be overriden by an environment variable on the target's OS (PIGPIO_PORT)

      • BUFFER_SIZE

        public static final GlcdOption<GlcdBufferSize> BUFFER_SIZE
        Specify the buffer size to be allocated for the display controller 1 page buffer, 2 page buffers or Full Screen Buffer

      • EXTRA_DEBUG_INFO

        public static final GlcdOption<java.lang.Boolean> EXTRA_DEBUG_INFO
        Show additional debug information on the console

    • Method Detail

      • getName

        public java.lang.String getName()
        Returns:
        The raw key/name of this option

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object