Mercurial > louis > kiibohd-controller

annotate Scan/STLcd/capabilities.kll @ 354:40bbbc667399

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Adding API to set pixels on LCD screen
author Jacob Alexander <haata@kiibohd.com>
date Sun, 02 Aug 2015 00:00:11 -0700
parents c6613db89cbe
children 0597f6c0d194
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
351
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
1 Name = STLcdCapabilities;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
2 Version = 0.1;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
3 Author = "HaaTa (Jacob Alexander) 2015";
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
4 KLL = 0.3c;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
5
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
6 # Modified Date
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
7 Date = 2015-08-01;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
8
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
9 # Defines available to the STLcd sub-module
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
10
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
11 # PWM Prescalar
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
12 # In general this can be left alone
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
13 # A higher prescalar should be lower power usage (less switching)
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
14 # However, flickering may be noticeable.
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
15 #
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
16 # Here's a calculation table valid at a 72 MHz system clock
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
17 # Prescalars range from 0 to 7 (1 to 128)
352
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
18
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
19 # Base FTM clock selection (72 MHz system clock)
354
40bbbc667399 Adding API to set pixels on LCD screen
Jacob Alexander <haata@kiibohd.com>
parents: 353
diff changeset
20 # @ 0xFFFF period, 72 MHz / (0xFFFF * 2) = Actual period
352
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
21 # Higher pre-scalar will use the most power (also look the best)
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
22 # Pre-scalar calculations
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
23 # 0 - 72 MHz -> 549 Hz
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
24 # 1 - 36 MHz -> 275 Hz
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
25 # 2 - 18 MHz -> 137 Hz
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
26 # 3 - 9 MHz -> 69 Hz (Slightly visible flicker)
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
27 # 4 - 4 500 kHz -> 34 Hz (Visible flickering)
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
28 # 5 - 2 250 kHz -> 17 Hz
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
29 # 6 - 1 125 kHz -> 9 Hz
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
30 # 7 - 562 500 Hz -> 4 Hz
351
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
31 STLcdBacklightPrescalar => STLcdBacklightPrescalar_define;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
32 STLcdBacklightPrescalar = 0;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
33
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
34 # Default Backlight Channel Brightness
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
35 # There are 3 channels, RGB
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
36 # In order to get other colors you must mix the 3 colors
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
37 # Each channel is a 16-bit register (65536 levels)
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
38 # Technically, this means, the backlight is a 48-bit RGB pixel
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
39 # In practice, it may be difficult to get color consistency at times if too bright or too dim
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
40 STLcdBacklightRed => STLcdBacklightRed_define;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
41 STLcdBacklightGreen => STLcdBacklightGreen_define;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
42 STLcdBacklightBlue => STLcdBacklightBlue_define;
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
43
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
44 # Defaults to 6% brightness, white
352
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
45 STLcdBacklightRed = 0x0FFF;
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
46 STLcdBacklightGreen = 0x0FFF;
99b567a3b1f2 Adding cli API call to set LCD backlight brightness (16 bit per channel)
Jacob Alexander <haata@kiibohd.com>
parents: 351
diff changeset
47 STLcdBacklightBlue = 0x0FFF;
351
38395a57cf52 Adding 16-bit brightness control to LCD backlight
Jacob Alexander <haata@kiibohd.com>
parents:
diff changeset
48
353
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
49
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
50 # Default LCD Image
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
51 #
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
52 # The easiest way to generate this data is using the bitmap2Struct.py script in this folder
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
53 # It will output the necessary uint8_t array to set here
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
54 #
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
55 STLcdDefaultImage => STLcdDefaultImage_define;
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
56
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
57 # Only the data portion is required
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
58 # Must be on a single line
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
59 STLcdDefaultImage = "0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x1f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xc0, 0xc0, 0xc0, 0xc0, 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x03, 0x03, 0x03, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0xf8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,";
c6613db89cbe Adding capability to set default image on LCD
Jacob Alexander <haata@kiibohd.com>
parents: 352
diff changeset
60