aboutsummaryrefslogtreecommitdiffstats
path: root/klippy/extras/display/hd44780.py
blob: 8cde1d6d6c44f9a2e8f3d3689ea8fafcef2cd452 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# Support for HD44780 (20x4 text) LCD displays
#
# Copyright (C) 2018  Kevin O'Connor <kevin@koconnor.net>
# Copyright (C) 2018  Eric Callahan <arksine.code@gmail.com>
#
# This file may be distributed under the terms of the GNU GPLv3 license.
import logging

BACKGROUND_PRIORITY_CLOCK = 0x7FFFFFFF00000000
LINE_LENGTH_DEFAULT = 20
LINE_LENGTH_OPTIONS = [16, 20]

TextGlyphs = {"right_arrow": b"\x7e"}

HD44780_DELAY = 0.000040


class HD44780:
    def __init__(self, config):
        self.printer = config.get_printer()
        # pin config
        ppins = self.printer.lookup_object("pins")
        pins = [
            ppins.lookup_pin(config.get(name + "_pin"))
            for name in ["rs", "e", "d4", "d5", "d6", "d7"]
        ]
        self.hd44780_protocol_init = config.getboolean("hd44780_protocol_init", True)
        self.line_length = config.getchoice(
            "line_length", LINE_LENGTH_OPTIONS, LINE_LENGTH_DEFAULT
        )
        mcu = None
        for pin_params in pins:
            if mcu is not None and pin_params["chip"] != mcu:
                raise ppins.error("hd44780 all pins must be on same mcu")
            mcu = pin_params["chip"]
        self.pins = [pin_params["pin"] for pin_params in pins]
        self.mcu = mcu
        self.oid = self.mcu.create_oid()
        self.mcu.register_config_callback(self.build_config)
        self.send_data_cmd = self.send_cmds_cmd = None
        self.icons = {}
        # framebuffers
        self.text_framebuffers = [
            bytearray(b" " * 2 * self.line_length),
            bytearray(b" " * 2 * self.line_length),
        ]
        self.glyph_framebuffer = bytearray(64)
        self.all_framebuffers = [
            # Text framebuffers
            (self.text_framebuffers[0], bytearray(b"~" * 2 * self.line_length), 0x80),
            (self.text_framebuffers[1], bytearray(b"~" * 2 * self.line_length), 0xC0),
            # Glyph framebuffer
            (self.glyph_framebuffer, bytearray(b"~" * 64), 0x40),
        ]

    def build_config(self):
        self.mcu.add_config_cmd(
            "config_hd44780 oid=%d rs_pin=%s e_pin=%s"
            " d4_pin=%s d5_pin=%s d6_pin=%s d7_pin=%s delay_ticks=%d"
            % (
                self.oid,
                self.pins[0],
                self.pins[1],
                self.pins[2],
                self.pins[3],
                self.pins[4],
                self.pins[5],
                self.mcu.seconds_to_clock(HD44780_DELAY),
            )
        )
        cmd_queue = self.mcu.alloc_command_queue()
        self.send_cmds_cmd = self.mcu.lookup_command(
            "hd44780_send_cmds oid=%c cmds=%*s", cq=cmd_queue
        )
        self.send_data_cmd = self.mcu.lookup_command(
            "hd44780_send_data oid=%c data=%*s", cq=cmd_queue
        )

    def send(self, cmds, is_data=False):
        cmd_type = self.send_cmds_cmd
        if is_data:
            cmd_type = self.send_data_cmd
        cmd_type.send([self.oid, cmds], reqclock=BACKGROUND_PRIORITY_CLOCK)
        # logging.debug("hd44780 %d %s", is_data, repr(cmds))

    def flush(self):
        # Find all differences in the framebuffers and send them to the chip
        for new_data, old_data, fb_id in self.all_framebuffers:
            if new_data == old_data:
                continue
            # Find the position of all changed bytes in this framebuffer
            diffs = [
                [i, 1] for i, (n, o) in enumerate(zip(new_data, old_data)) if n != o
            ]
            # Batch together changes that are close to each other
            for i in range(len(diffs) - 2, -1, -1):
                pos, count = diffs[i]
                nextpos, nextcount = diffs[i + 1]
                if pos + 4 >= nextpos and nextcount < 16:
                    diffs[i][1] = nextcount + (nextpos - pos)
                    del diffs[i + 1]
            # Transmit changes
            for pos, count in diffs:
                chip_pos = pos
                self.send([fb_id + chip_pos])
                self.send(new_data[pos : pos + count], is_data=True)
            old_data[:] = new_data

    def init(self):
        curtime = self.printer.get_reactor().monotonic()
        print_time = self.mcu.estimated_print_time(curtime)
        # Program 4bit / 2-line mode and then issue 0x02 "Home" command
        if self.hd44780_protocol_init:
            init = [[0x33], [0x33], [0x32], [0x28, 0x28, 0x02]]
        else:
            init = [[0x02]]
        # Reset (set positive direction ; enable display and hide cursor)
        init.append([0x06, 0x0C])
        for i, cmds in enumerate(init):
            minclock = self.mcu.print_time_to_clock(print_time + i * 0.100)
            self.send_cmds_cmd.send([self.oid, cmds], minclock=minclock)
        self.flush()

    def write_text(self, x, y, data):
        if x + len(data) > self.line_length:
            data = data[: self.line_length - min(x, self.line_length)]
        pos = x + ((y & 0x02) >> 1) * self.line_length
        self.text_framebuffers[y & 1][pos : pos + len(data)] = data

    def set_glyphs(self, glyphs):
        for glyph_name, glyph_data in glyphs.items():
            data = glyph_data.get("icon5x8")
            if data is not None:
                self.icons[glyph_name] = data

    def write_glyph(self, x, y, glyph_name):
        data = self.icons.get(glyph_name)
        if data is not None:
            slot, bits = data
            self.write_text(x, y, [slot])
            self.glyph_framebuffer[slot * 8 : (slot + 1) * 8] = bits
            return 1
        char = TextGlyphs.get(glyph_name)
        if char is not None:
            # Draw character
            self.write_text(x, y, char)
            return 1
        return 0

    def write_graphics(self, x, y, data):
        pass

    def clear(self):
        spaces = b" " * 2 * self.line_length
        self.text_framebuffers[0][:] = spaces
        self.text_framebuffers[1][:] = spaces

    def get_dimensions(self):
        return (self.line_length, 4)