Skip to content

Commit 52a8f2a

Browse files
BlitzCityDIYBlitzCityDIY
authored
Merge pull request #2737 from adafruit/kitty_printer
adding cat printer code
2 parents d33b157 + 41afe52 commit 52a8f2a

File tree

5 files changed

+597
-0
lines changed

5 files changed

+597
-0
lines changed

‎MEMENTO/Memento_Cat_Printer/.pycamera_s3.generate

Whitespace-only changes.

‎MEMENTO/Memento_Cat_Printer/.pycamera_s3.test.only

Whitespace-only changes.

‎MEMENTO/Memento_Cat_Printer/CatGFX.cpp

Lines changed: 271 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,271 @@
1+
// SPDX-FileCopyrightText: 2022 Claus Näveke
2+
//
3+
// SPDX-License-Identifier: Unlicense
4+
// https://github.com/TheNitek/CatGFX
5+
6+
#include "CatGFX.h"
7+
8+
CatPrinter::CatPrinter(uint16_t h):
9+
Adafruit_GFX(384, h),
10+
WIDTH_BYTE((WIDTH + 7)/8),
11+
SERVICE_UUID("0000AE30-0000-1000-8000-00805F9B34FB"),
12+
CHAR_UUID_DATA("0000AE01-0000-1000-8000-00805F9B34FB")
13+
{
14+
if (this->NAME_ARRAY_SIZE >= 5)
15+
{
16+
strcpy(this->printerNames[0], "GT01");
17+
strcpy(this->printerNames[1], "GB01");
18+
strcpy(this->printerNames[2], "GB02");
19+
strcpy(this->printerNames[3], "MX09");
20+
strcpy(this->printerNames[4], "MX06");
21+
for (int i = 4; i < this->NAME_ARRAY_SIZE; i ++)
22+
strcpy(this->printerNames[i], "");
23+
}
24+
else if (this->NAME_ARRAY_SIZE >= 1)
25+
strcpy(this->printerNames[0], "");
26+
}
27+
28+
void CatPrinter::begin(byte *buffer, uint16_t size) {
29+
pixelBuffer = buffer;
30+
pixelBufferSize = size;
31+
32+
BLEDevice::init("ESP32");
33+
bleScan->setAdvertisedDeviceCallbacks(this);
34+
bleScan->setActiveScan(true);
35+
}
36+
37+
void CatPrinter::fillBuffer(const byte value) {
38+
if (pixelBuffer != nullptr)
39+
memset(pixelBuffer, value, pixelBufferSize);
40+
}
41+
42+
bool CatPrinter::connect(void) {
43+
bleScan->start(5);
44+
if(blePrinterAddress == nullptr) {
45+
return false;
46+
}
47+
return connect(*blePrinterAddress);
48+
}
49+
50+
bool CatPrinter::connect(BLEAddress &address) {
51+
if(!bleClient->connect(address)) {
52+
Serial.println("Connect failed");
53+
return false;
54+
}
55+
56+
BLERemoteService* pRemoteService = bleClient->getService(SERVICE_UUID);
57+
if(pRemoteService != nullptr) {
58+
pRemoteCharacteristicData = pRemoteService->getCharacteristic(CHAR_UUID_DATA);
59+
if(pRemoteCharacteristicData != nullptr) {
60+
Serial.println("Got data transfer characteristic!");
61+
return true;
62+
}
63+
}
64+
else {
65+
bleClient->disconnect();
66+
Serial.println("Data service not found");
67+
}
68+
return false;
69+
}
70+
71+
void CatPrinter::disconnect(void) {
72+
bleClient->disconnect();
73+
74+
if(blePrinterAddress != nullptr) {
75+
delete blePrinterAddress;
76+
blePrinterAddress = nullptr;
77+
}
78+
}
79+
80+
void CatPrinter::sendLine(const byte *data, const uint8_t len, const bool compressed) {
81+
//Serial.println("send line..");
82+
if(compressed) {
83+
//Serial.println("compressed");
84+
byte comp[WIDTH_BYTE] = {0};
85+
uint8_t cb = 0;
86+
87+
// Get color of first pixel
88+
comp[0] = data[0] & 0x80;
89+
90+
for (uint16_t i=0; i<len; i++) {
91+
for(uint8_t j=0; j<8; j++) {
92+
if(((data[i] >> (7-j)) & 0x01) != (comp[cb] >> 7) || ((comp[cb] & 0x7F) == 0x7F)) {
93+
cb++;
94+
if(cb >= WIDTH_BYTE) {
95+
// Not a compressable line, so dont
96+
sendLine(data, len, false);
97+
return;
98+
}
99+
comp[cb] = ((data[i] >> (7-j)) & 0x01) << 7;
100+
}
101+
comp[cb]++;
102+
}
103+
}
104+
cb++;
105+
sendCmd(CatPrinter::Cmd::PRINT_COMPRESSED, comp, cb);
106+
} else {
107+
//Serial.println("not compressed");
108+
byte buff[WIDTH_BYTE];
109+
//delay(200);
110+
for (uint8_t i=0; i<len; i++) {
111+
buff[i] = MIRROR_TABLE[data[i]];
112+
}
113+
//Serial.println("sending command..");
114+
sendCmd(CatPrinter::Cmd::PRINT, buff, len);
115+
delay(10);
116+
}
117+
}
118+
119+
void CatPrinter::feed(uint8_t lines) {
120+
byte data[] = {lines, 0};
121+
sendCmd(CatPrinter::Cmd::PAPER_FEED, data, sizeof(data));
122+
}
123+
124+
void CatPrinter::printBuffer(void) {
125+
Serial.println("print buffer..");
126+
startGraphics();
127+
128+
// Print the graphics
129+
byte *s = pixelBuffer;
130+
for (uint16_t y=0; y<HEIGHT; y++) {
131+
//delay(10);
132+
sendLine(s, WIDTH_BYTE, false);
133+
s += WIDTH_BYTE;
134+
// Stop if the rest of the buffer is empty
135+
if(s[0] == 0 && !memcmp(s, s+1, (HEIGHT-y-1)*WIDTH_BYTE-1)) {
136+
break;
137+
}
138+
}
139+
//Serial.println("end of print buffer");
140+
endGraphics();
141+
}
142+
143+
void CatPrinter::onResult(BLEAdvertisedDevice advertisedDevice) {
144+
//Serial.println("on result");
145+
uint8_t i = 0;
146+
delay(200);
147+
while (i < this->NAME_ARRAY_SIZE && strcmp(this->printerNames[i], "") != 0){
148+
if (strcmp(advertisedDevice.getName().c_str(), this->printerNames[i]) == 0) {
149+
blePrinterAddress = new BLEAddress(advertisedDevice.getAddress());
150+
Serial.print("Found Printer: ");
151+
Serial.println(blePrinterAddress->toString().c_str());
152+
bleScan->stop();
153+
break ;
154+
}
155+
else
156+
i ++;
157+
}
158+
}
159+
160+
void CatPrinter::sendCmd(const CatPrinter::Cmd cmd, const byte *data, const uint8_t len) {
161+
//Serial.println("send cmd");
162+
byte buffer[WIDTH_BYTE+8] = {0x51, 0x78};
163+
buffer[2] = static_cast<byte>(cmd);
164+
buffer[4] = len;
165+
memcpy(buffer + 6, data, len);
166+
buffer[6 + len] = crc(data, len);
167+
buffer[6 + len + 1] = 0xFF;
168+
169+
writeData(buffer, len+8);
170+
delay(10);
171+
}
172+
173+
byte CatPrinter::crc(const byte *data, const uint8_t len) {
174+
byte cs = 0;
175+
176+
for (uint8_t i=0; i<len; i++) {
177+
cs = CRC_TABLE[(cs ^ data[i])];
178+
}
179+
return cs;
180+
}
181+
182+
void CatPrinter::writeData(byte *data, uint8_t len) {
183+
//Serial.println("write data");
184+
if (!bleClient->isConnected()) {
185+
return;
186+
}
187+
188+
// Write in smaller packages, because bigger ones don't work for unkown reason
189+
while (len > PACKET_SIZE) {
190+
delay(2);
191+
Serial.print(".");
192+
pRemoteCharacteristicData->writeValue(data, PACKET_SIZE);
193+
data += PACKET_SIZE;
194+
len -= PACKET_SIZE;
195+
//Serial.println("wrote packet, len > packet_size");
196+
//delay(200);
197+
}
198+
if (len) {
199+
delay(2);
200+
pRemoteCharacteristicData->writeValue(data, len);
201+
//delay(200);
202+
Serial.println(".");
203+
//Serial.println("wrote packet, len < packet_size");
204+
}
205+
}
206+
207+
void CatPrinter::startGraphics(void) {
208+
Serial.println("starting graphics..");
209+
byte data[2] = {0x80, 0x3E};
210+
sendCmd(CatPrinter::Cmd::ENERGY, data, 2);
211+
//delay(10);
212+
data[0] = 0x33;
213+
sendCmd(CatPrinter::Cmd::QUALITY, data, 1);
214+
//delay(10);
215+
data[0] = 0x00;
216+
sendCmd(CatPrinter::Cmd::DRAWING_MODE, data, 1);
217+
//delay(10);
218+
sendCmd(CatPrinter::Cmd::LATTICE, LATTICE_START, sizeof(LATTICE_START));
219+
//delay(10);
220+
}
221+
222+
void CatPrinter::endGraphics(void) {
223+
sendCmd(CatPrinter::Cmd::LATTICE, LATTICE_END, sizeof(LATTICE_END));
224+
delay(200);
225+
Serial.println("ended graphics");
226+
}
227+
228+
void CatPrinter::drawPixel(int16_t x, int16_t y, uint16_t color) {
229+
if ((x < 0) || (x >= width()) || (y < 0) || (y >= height())) {
230+
// Out of bounds
231+
return;
232+
}
233+
uint16_t byteNo = x/8 + (y * WIDTH_BYTE);
234+
uint8_t bitNo = 7-(x%8);
235+
pixelBuffer[byteNo] = (pixelBuffer[byteNo] & ~(1 << bitNo)) | ((!color ? 1 : 0) << bitNo);
236+
}
237+
238+
void CatPrinter::fillScreen(uint16_t color) {
239+
fillBuffer((!color ? 0xFF : 0x00));
240+
}
241+
242+
void CatPrinter::resetNameArray(void)
243+
{
244+
for (uint8_t i = 0; i < this->NAME_ARRAY_SIZE; i ++)
245+
strcpy(this->printerNames[i], "");
246+
}
247+
248+
bool CatPrinter::addNameArray(char *newname)
249+
{
250+
uint8_t i = 0;
251+
252+
if (strlen(newname) >= NAME_STRING_SIZE)
253+
return (false);
254+
while (i < this->NAME_ARRAY_SIZE)
255+
{
256+
if (strcmp(this->printerNames[i], "") != 0)
257+
i ++;
258+
else
259+
break ;
260+
}
261+
if (i >= this->NAME_ARRAY_SIZE - 1)
262+
return (false);
263+
strcpy(this->printerNames[i], newname);
264+
return (true);
265+
}
266+
267+
void CatPrinter::printNameArray(void)
268+
{
269+
for (uint8_t i = 0; i < NAME_ARRAY_SIZE; i ++)
270+
Serial.println(this->printerNames[i]);
271+
}

‎MEMENTO/Memento_Cat_Printer/CatGFX.h

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
// SPDX-FileCopyrightText: 2022 Claus Näveke
2+
//
3+
// SPDX-License-Identifier: Unlicense
4+
// https://github.com/TheNitek/CatGFX
5+
6+
#include <Arduino.h>
7+
#include <Adafruit_GFX.h>
8+
#include <BLEDevice.h>
9+
10+
class CatPrinter: public Adafruit_GFX, public BLEAdvertisedDeviceCallbacks {
11+
public:
12+
enum class Cmd {
13+
REVERSE_FEED = 0xA0,
14+
PAPER_FEED = 0xA1,
15+
PRINT = 0xA2,
16+
QUALITY = 0xA4,
17+
LATTICE = 0xA6,
18+
UPDATE = 0xA9,
19+
ENERGY = 0xAF,
20+
DRAWING_MODE = 0xBE,
21+
PRINT_COMPRESSED = 0xBF
22+
};
23+
CatPrinter(uint16_t h);
24+
~CatPrinter() {
25+
delete bleClient;
26+
}
27+
void begin(byte *buffer, uint16_t size);
28+
void fillBuffer(const byte value);
29+
bool connect(void);
30+
bool connect(BLEAddress &address);
31+
void disconnect(void);
32+
void sendLine(const byte *data, const uint8_t len, const bool compressed = true);
33+
void feed(uint8_t lines);
34+
void printBuffer(void);
35+
void sendCmd(const CatPrinter::Cmd cmd, const byte *data, const uint8_t len);
36+
// GFX overrides
37+
void drawPixel(int16_t x, int16_t y, uint16_t color) override;
38+
void fillScreen(uint16_t color) override;
39+
void startGraphics(void);
40+
void endGraphics(void);
41+
void resetNameArray(void);
42+
bool addNameArray(char *newname);
43+
void printNameArray(void);
44+
45+
private:
46+
byte *pixelBuffer = nullptr;
47+
uint16_t pixelBufferSize = 0;
48+
const uint8_t PACKET_SIZE = 20;
49+
const uint8_t WIDTH_BYTE = 48; // 384 pixel / 8 bits => 48 byte
50+
51+
const BLEUUID SERVICE_UUID;
52+
const BLEUUID CHAR_UUID_DATA;
53+
54+
BLEAddress *blePrinterAddress = nullptr;
55+
BLERemoteCharacteristic* pRemoteCharacteristicData = nullptr;
56+
BLEScan *bleScan = BLEDevice::getScan();
57+
BLEClient *bleClient = BLEDevice::createClient();;
58+
59+
//Indicates the end of the array with an empty string instead of NULL.
60+
const static uint8_t NAME_ARRAY_SIZE = 6;
61+
const static uint8_t NAME_STRING_SIZE = 8;
62+
char printerNames[NAME_ARRAY_SIZE][NAME_STRING_SIZE];
63+
64+
const byte LATTICE_START[11] = {0xAA, 0x55, 0x17, 0x38, 0x44, 0x5F, 0x5F, 0x5F, 0x44, 0x38, 0x2C};
65+
const byte LATTICE_END[11] = {0xAA, 0x55, 0x17, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x17};
66+
const byte FEED_LINE_DATA[2] = {0x01, 0x00};
67+
68+
const byte CRC_TABLE[256] = {
69+
0x00, 0x07, 0x0e, 0x09, 0x1c, 0x1b, 0x12, 0x15, 0x38, 0x3f, 0x36, 0x31,
70+
0x24, 0x23, 0x2a, 0x2d, 0x70, 0x77, 0x7e, 0x79, 0x6c, 0x6b, 0x62, 0x65,
71+
0x48, 0x4f, 0x46, 0x41, 0x54, 0x53, 0x5a, 0x5d, 0xe0, 0xe7, 0xee, 0xe9,
72+
0xfc, 0xfb, 0xf2, 0xf5, 0xd8, 0xdf, 0xd6, 0xd1, 0xc4, 0xc3, 0xca, 0xcd,
73+
0x90, 0x97, 0x9e, 0x99, 0x8c, 0x8b, 0x82, 0x85, 0xa8, 0xaf, 0xa6, 0xa1,
74+
0xb4, 0xb3, 0xba, 0xbd, 0xc7, 0xc0, 0xc9, 0xce, 0xdb, 0xdc, 0xd5, 0xd2,
75+
0xff, 0xf8, 0xf1, 0xf6, 0xe3, 0xe4, 0xed, 0xea, 0xb7, 0xb0, 0xb9, 0xbe,
76+
0xab, 0xac, 0xa5, 0xa2, 0x8f, 0x88, 0x81, 0x86, 0x93, 0x94, 0x9d, 0x9a,
77+
0x27, 0x20, 0x29, 0x2e, 0x3b, 0x3c, 0x35, 0x32, 0x1f, 0x18, 0x11, 0x16,
78+
0x03, 0x04, 0x0d, 0x0a, 0x57, 0x50, 0x59, 0x5e, 0x4b, 0x4c, 0x45, 0x42,
79+
0x6f, 0x68, 0x61, 0x66, 0x73, 0x74, 0x7d, 0x7a, 0x89, 0x8e, 0x87, 0x80,
80+
0x95, 0x92, 0x9b, 0x9c, 0xb1, 0xb6, 0xbf, 0xb8, 0xad, 0xaa, 0xa3, 0xa4,
81+
0xf9, 0xfe, 0xf7, 0xf0, 0xe5, 0xe2, 0xeb, 0xec, 0xc1, 0xc6, 0xcf, 0xc8,
82+
0xdd, 0xda, 0xd3, 0xd4, 0x69, 0x6e, 0x67, 0x60, 0x75, 0x72, 0x7b, 0x7c,
83+
0x51, 0x56, 0x5f, 0x58, 0x4d, 0x4a, 0x43, 0x44, 0x19, 0x1e, 0x17, 0x10,
84+
0x05, 0x02, 0x0b, 0x0c, 0x21, 0x26, 0x2f, 0x28, 0x3d, 0x3a, 0x33, 0x34,
85+
0x4e, 0x49, 0x40, 0x47, 0x52, 0x55, 0x5c, 0x5b, 0x76, 0x71, 0x78, 0x7f,
86+
0x6a, 0x6d, 0x64, 0x63, 0x3e, 0x39, 0x30, 0x37, 0x22, 0x25, 0x2c, 0x2b,
87+
0x06, 0x01, 0x08, 0x0f, 0x1a, 0x1d, 0x14, 0x13, 0xae, 0xa9, 0xa0, 0xa7,
88+
0xb2, 0xb5, 0xbc, 0xbb, 0x96, 0x91, 0x98, 0x9f, 0x8a, 0x8d, 0x84, 0x83,
89+
0xde, 0xd9, 0xd0, 0xd7, 0xc2, 0xc5, 0xcc, 0xcb, 0xe6, 0xe1, 0xe8, 0xef,
90+
0xfa, 0xfd, 0xf4, 0xf3
91+
};
92+
93+
const byte MIRROR_TABLE[256] = {
94+
0x00, 0x80, 0x40, 0xC0, 0x20, 0xA0, 0x60, 0xE0, 0x10, 0x90, 0x50, 0xD0,
95+
0x30, 0xB0, 0x70, 0xF0, 0x08, 0x88, 0x48, 0xC8, 0x28, 0xA8, 0x68, 0xE8,
96+
0x18, 0x98, 0x58, 0xD8, 0x38, 0xB8, 0x78, 0xF8, 0x04, 0x84, 0x44, 0xC4,
97+
0x24, 0xA4, 0x64, 0xE4, 0x14, 0x94, 0x54, 0xD4, 0x34, 0xB4, 0x74, 0xF4,
98+
0x0C, 0x8C, 0x4C, 0xCC, 0x2C, 0xAC, 0x6C, 0xEC, 0x1C, 0x9C, 0x5C, 0xDC,
99+
0x3C, 0xBC, 0x7C, 0xFC, 0x02, 0x82, 0x42, 0xC2, 0x22, 0xA2, 0x62, 0xE2,
100+
0x12, 0x92, 0x52, 0xD2, 0x32, 0xB2, 0x72, 0xF2, 0x0A, 0x8A, 0x4A, 0xCA,
101+
0x2A, 0xAA, 0x6A, 0xEA, 0x1A, 0x9A, 0x5A, 0xDA, 0x3A, 0xBA, 0x7A, 0xFA,
102+
0x06, 0x86, 0x46, 0xC6, 0x26, 0xA6, 0x66, 0xE6, 0x16, 0x96, 0x56, 0xD6,
103+
0x36, 0xB6, 0x76, 0xF6, 0x0E, 0x8E, 0x4E, 0xCE, 0x2E, 0xAE, 0x6E, 0xEE,
104+
0x1E, 0x9E, 0x5E, 0xDE, 0x3E, 0xBE, 0x7E, 0xFE, 0x01, 0x81, 0x41, 0xC1,
105+
0x21, 0xA1, 0x61, 0xE1, 0x11, 0x91, 0x51, 0xD1, 0x31, 0xB1, 0x71, 0xF1,
106+
0x09, 0x89, 0x49, 0xC9, 0x29, 0xA9, 0x69, 0xE9, 0x19, 0x99, 0x59, 0xD9,
107+
0x39, 0xB9, 0x79, 0xF9, 0x05, 0x85, 0x45, 0xC5, 0x25, 0xA5, 0x65, 0xE5,
108+
0x15, 0x95, 0x55, 0xD5, 0x35, 0xB5, 0x75, 0xF5, 0x0D, 0x8D, 0x4D, 0xCD,
109+
0x2D, 0xAD, 0x6D, 0xED, 0x1D, 0x9D, 0x5D, 0xDD, 0x3D, 0xBD, 0x7D, 0xFD,
110+
0x03, 0x83, 0x43, 0xC3, 0x23, 0xA3, 0x63, 0xE3, 0x13, 0x93, 0x53, 0xD3,
111+
0x33, 0xB3, 0x73, 0xF3, 0x0B, 0x8B, 0x4B, 0xCB, 0x2B, 0xAB, 0x6B, 0xEB,
112+
0x1B, 0x9B, 0x5B, 0xDB, 0x3B, 0xBB, 0x7B, 0xFB, 0x07, 0x87, 0x47, 0xC7,
113+
0x27, 0xA7, 0x67, 0xE7, 0x17, 0x97, 0x57, 0xD7, 0x37, 0xB7, 0x77, 0xF7,
114+
0x0F, 0x8F, 0x4F, 0xCF, 0x2F, 0xAF, 0x6F, 0xEF, 0x1F, 0x9F, 0x5F, 0xDF,
115+
0x3F, 0xBF, 0x7F, 0xFF
116+
};
117+
118+
void onResult(BLEAdvertisedDevice advertisedDevice) override;
119+
uint8_t crc(const byte *data, const uint8_t len);
120+
void writeData(byte *data, uint8_t len);
121+
};

0 commit comments

Comments
 (0)