1# Copyright (c) 2023 Jan Henke <Jan.Henke@taujhe.de>
2# SPDX-License-Identifier: Apache-2.0
3
4description: |
5  SparkFun SerLCD Dot Character VFD Controller/Driver IC
6
7  Example:
8    &i2c1 {
9      serlcd@72 {
10        compatible = "sparkfun,serlcd";
11        reg = <0x72>;
12        columns = <16>;
13        rows = <2>;
14        command-delay-ms = <10>;
15        special-command-delay-ms = <50>;
16      };
17    };
18
19compatible: "sparkfun,serlcd"
20
21include: [auxdisplay-device.yaml, i2c-device.yaml]
22
23properties:
24  columns:
25    type: int
26    default: 16
27    enum:
28      - 16
29      - 20
30
31  rows:
32    type: int
33    default: 2
34    enum:
35      - 2
36      - 4
37
38  command-delay-ms:
39    type: int
40    default: 10
41    description: |
42      Delay in milliseconds (defaults to 10ms if not set) after a normal command was sent.
43      The default value is based on the original SparkFun SerLCD library
44      implementation which assumes 100 kbps I2C configuration. This value
45      might require tweaking if using I2C at a higher bitrare and/or relativily
46      high update frequency of the display.
47
48  special-command-delay-ms:
49    type: int
50    default: 50
51    description: |
52      Delay in milliseconds (defaults to 50ms if not set) after a special command was sent.
53      The default value is based on the original SparkFun SerLCD library
54      implementation which assumes 100 kbps I2C configuration. This value
55      might require tweaking if using I2C at a higher bitrare and/or relativily
56      high update frequency of the display.
57