├── README.md ├── sk.h └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # SK6812-RGBW-ESP32 2 | Quick little class to drive SK6812 RGBW leds reliably on a ESP32 3 | 4 | All libraries I have tried on ESP32 resulted in flashing, weird colours. When using the Arduino RMT code, 5 | it caused artefacts on the SPI display I used in the same project. 6 | 7 | I made this small class to succesfully ( i.e. no flicker and no artefacts on my SPI display) drive my SK6812 RGBW strip. 8 | Use at your own peril, for WS2812s you must change the timing and the number of bytes per pixel, but it's a way forward maybe. 9 | -------------------------------------------------------------------------------- /sk.h: -------------------------------------------------------------------------------- 1 | #ifndef SK_H 2 | #define SK_H 1 3 | 4 | 5 | #include "driver/rmt.h" 6 | 7 | 8 | //Use RMT for a strip of SK6812 RGBW leds 9 | 10 | 11 | 12 | class sk{ 13 | public: 14 | sk(void){} 15 | ~sk(void){ 16 | 17 | free( _skstrip); 18 | rmt_driver_uninstall( skconfig.channel ); 19 | } 20 | 21 | 22 | /*-------------------------------------------------------------------------*/ 23 | int begin( int pin, int count){ 24 | 25 | _bitcount = count*32; 26 | _ledpin = pin; 27 | _ledcount = count; 28 | _brightness = 100; 29 | 30 | int rc; 31 | 32 | _skstrip = (rmt_item32_t *)calloc( _bitcount, sizeof( rmt_item32_t ) ); 33 | 34 | skconfig.rmt_mode = RMT_MODE_TX; 35 | skconfig.channel = RMT_CHANNEL_7; 36 | skconfig.gpio_num = (gpio_num_t)_ledpin; 37 | skconfig.mem_block_num = 1; 38 | skconfig.tx_config.loop_en = 0; 39 | skconfig.tx_config.carrier_en = 0; 40 | skconfig.tx_config.idle_output_en = 1; 41 | skconfig.tx_config.idle_level = RMT_IDLE_LEVEL_LOW; 42 | skconfig.tx_config.carrier_level = RMT_CARRIER_LEVEL_HIGH; 43 | skconfig.clk_div = 8; // 80MHx / 8 = 10MHz translates to 0,1 us = 100 ns per count 44 | 45 | rmt_config( &skconfig); 46 | rc = rmt_driver_install( skconfig.channel, 0, 0); // rmt_driver_install(rmt_channel_t channel, size_t rx_buf_size, int rmt_intr_num) 47 | 48 | return(rc); 49 | } 50 | 51 | /*-------------------------------------------------------------------------*/ 52 | uint32_t getcolor( uint8_t r,uint8_t g,uint8_t b,uint8_t w ){ 53 | 54 | uint32_t kleur=0; 55 | 56 | kleur |= ((uint32_t)g<<24); 57 | kleur |= ((uint32_t)r<<16); 58 | kleur |= ((uint32_t)b<<8); 59 | kleur |= (uint32_t)w; 60 | 61 | return( kleur ); 62 | } 63 | 64 | /*-------------------------------------------------------------------------*/ 65 | 66 | uint32_t breakcolor( uint32_t kleur, uint8_t *r,uint8_t *g,uint8_t *b,uint8_t *w ){ 67 | 68 | *g = (kleur >> 24 )&0xff; 69 | *r = (kleur >> 16 )&0xff; 70 | *b = (kleur >> 8 )&0xff; 71 | *w = kleur&0xff; 72 | 73 | return( kleur ); 74 | } 75 | 76 | 77 | /*-------------------------------------------------------------------------*/ 78 | void color32( int led, uint32_t kleur, int brightness = -1 ){ 79 | uint8_t r,g,b,w; 80 | 81 | breakcolor( kleur,&r,&g,&b,&w); 82 | color( led, r,g,b,w, brightness); 83 | 84 | } 85 | 86 | /*-------------------------------------------------------------------------*/ 87 | void color( int led, uint8_t red,uint8_t green,uint8_t blue,uint8_t white, int brightness = -1 ){ 88 | uint32_t kleur=0, bright; 89 | uint8_t r = red, g = green, b = blue, w = white; 90 | int i,bit; 91 | 92 | if ( led < 0 || led >= ledcount() ) return; 93 | 94 | //Serial.printf( "---\nrgbw = %d.%d.%d.%d\n", red,green,blue,white); 95 | // brightness is a percentage 0...100 96 | 97 | bright = brightness; 98 | if ( brightness == -1 ) bright = 100; 99 | 100 | bright = (bright * _brightness) /100; 101 | 102 | r = bright*red/100; 103 | g = bright*green/100; 104 | b = bright*blue/100; 105 | w = bright*white/100; 106 | 107 | //Serial.printf("_brightness = %d, brightness %d, bright %d\n", _brightness, brightness, bright); 108 | //Serial.printf( "rgbw = %d.%d.%d.%d\n---\n", r,g,b,w); 109 | 110 | kleur |= ((uint32_t)g<<24); 111 | kleur |= ((uint32_t)r<<16); 112 | kleur |= ((uint32_t)b<<8); 113 | kleur |= (uint32_t)w; 114 | 115 | //Serial.printf("Set color of led %d kleur %08X\n", led, kleur); 116 | // sk6812 has around 600us/600us 1, 300/900us 0 117 | 118 | for (i=(led*32),bit=0; bit<32; bit++){ 119 | 120 | if ( (kleur & (1<<(31-bit))) ) { 121 | _skstrip[i].level0 = 1; 122 | _skstrip[i].duration0 = 6; 123 | _skstrip[i].level1 = 0; 124 | _skstrip[i].duration1 = 6; 125 | } else { 126 | _skstrip[i].level0 = 1; 127 | _skstrip[i].duration0 = 3; 128 | _skstrip[i].level1 = 0; 129 | _skstrip[i].duration1 = 9; 130 | } 131 | //if ( bit == 31 ) _skstrip[i].duration1 += 60; 132 | ++i; 133 | } 134 | 135 | return; 136 | } 137 | 138 | 139 | /*-------------------------------------------------------------------------*/ 140 | void show(){ 141 | 142 | int rc; 143 | // esp_err_t rmt_write_items(rmt_channel_t channel, rmt_item32_t *rmt_item, int item_num, bool wait_tx_done) 144 | 145 | rc = rmt_write_items(skconfig.channel, _skstrip, _bitcount, 1); 146 | 147 | 148 | delay(2); 149 | 150 | } 151 | 152 | /*-------------------------------------------------------------------------*/ 153 | 154 | void clear( void ){ 155 | 156 | 157 | for ( int i =0; i < _ledcount;++i ) { 158 | color(i,0,0,0,0); 159 | } 160 | 161 | show(); 162 | delay(10); 163 | 164 | } 165 | 166 | /*-------------------------------------------------------------------------*/ 167 | uint8_t setbrightness(uint8_t newbrightness ){ 168 | _brightness = newbrightness; 169 | return( _brightness ); 170 | } 171 | /*-------------------------------------------------------------------------*/ 172 | uint8_t getbrightness(){ 173 | return( _brightness ); 174 | } 175 | /*-------------------------------------------------------------------------*/ 176 | 177 | int ledcount(){ 178 | return( _ledcount); 179 | } 180 | 181 | /*-------------------------------------------------------------------------*/ 182 | 183 | private: 184 | int _ledcount; 185 | int _bitcount; 186 | int _ledpin; 187 | int _brightness; 188 | rmt_item32_t* _skstrip = NULL; 189 | rmt_config_t skconfig; 190 | float _realtick; 191 | 192 | }; 193 | 194 | #endif 195 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------