Add support to mix ws2812.buffer objects. #1575

pjsg · 2016-10-31T02:09:14Z

This PR is for the dev branch rather than for master.
This PR is compliant with the other contributing guidelines as well (if not, please describe why).
I have thoroughly tested my contribution.
The code changes are reflected in the documentation at docs/en/*.

This adds a number of new methods on the ws2812.buffer object.

mix -- mix together a number of buffers in adjustable rations
power -- get the total power consumption of a buffer (useful if your power supply is limited)
load/dump -- convert a buffer to and from a string (in the raw string format)
__tostring -- format the buffer in a way that is useful for debug printing

Updated the documentation to match. Also improved the verification of the user data object.

devsaurus

Overall a good evolution for ws2812.
The ws2812.udata thingy needs to be clarified before merging.

devsaurus · 2016-11-01T11:16:48Z

app/modules/ws2812.c

@@ -132,8 +131,7 @@ static int ws2812_write(lua_State* L) {
  }
  else if (type == LUA_TUSERDATA)
  {
-    ws2812_buffer * buffer = (ws2812_buffer*)lua_touserdata(L, 1);
-    luaL_argcheck(L, buffer && buffer->canary == CANARY_VALUE, 1, "ws2812.buffer expected");


What was the purpose of this CANARY_VALUE anyway?

It was an attempt (I think) to verify that the right type of userdata was provided. I switched over to using the standard method.

devsaurus · 2016-11-01T11:18:02Z

app/modules/ws2812.c

@@ -230,11 +224,10 @@ static int ws2812_buffer_fill(lua_State* L) {
 }

 static int ws2812_buffer_fade(lua_State* L) {
-  ws2812_buffer * buffer = (ws2812_buffer*)lua_touserdata(L, 1);
+  ws2812_buffer * buffer = (ws2812_buffer*)luaL_checkudata(L, 1, "ws2812.udata");


What is ws2812.udata - did you mean ws2812.buffer?

yes -- now fixed

devsaurus · 2016-11-01T11:18:27Z

app/modules/ws2812.c

@@ -260,11 +253,10 @@ static int ws2812_buffer_fade(lua_State* L) {


 static int ws2812_buffer_shift(lua_State* L) {
-  ws2812_buffer * buffer = (ws2812_buffer*)lua_touserdata(L, 1);
+  ws2812_buffer * buffer = (ws2812_buffer*)luaL_checkudata(L, 1, "ws2812.udata");


ws2812.buffer?

devsaurus · 2016-11-01T11:21:17Z

docs/en/modules/ws2812.md

+```
+
+## ws2812.buffer:load()
+Converts a string into a buffer (see also the `dump` method). The buffer must have the correct shape or an error will be thrown.


"correct shape" means that length has to match exactly? Or could the loaded string be smaller, filling only a portion of the buffer (with an optional index as offset)?

I've changed this to be more general purpose and allow an insert operation into the middle of another buffer. Also, the source can either be a buffer or a string.

devsaurus · 2016-11-01T11:32:30Z

docs/en/modules/ws2812.md

+
+## ws2812.buffer:power()
+Computes the total energy requirement for the buffer. This is merely the total sum of all the pixel values (which assumes that each color in each
+pixel consumes the same amount of power).


The datasheets don't provide any clue on this aspect. Do you have further information/links that back this? Same for the assumption that pixel values translate linearly to current consumption.

The WS2812 is just three leds with a WS2811 chip. The datasheet for this chip (e.g. https://cdn-shop.adafruit.com/datasheets/WS2811.pdf ) indicates that each channel (R, G, B) is a 20ma constant current drive. The brightness is controlled by a variable duty cycle (per channel). I assumed that the duty cycle scaled linearly with the pixel value (it would be more difficult to to otherwise). This means that the average current is colorvalue / 255 * 20mA.

I aso added some of this text to the docs.

devsaurus · 2016-11-01T11:38:12Z

app/modules/ws2812.c

+static int ws2812_buffer_tostring(lua_State* L) {
+  ws2812_buffer * buffer = (ws2812_buffer*)luaL_checkudata(L, 1, "ws2812.buffer");
+
+  luaL_Buffer result;


Does this implementation work for RGB chains longer than 85 (aka LUAL_BUFFERSIZE / 3)?

Yes. It works on my 144 led strip that is sitting on my kitchen table. Even my daughter said "Ooo!" (I have a couple of led chasers running)

devsaurus · 2016-11-02T17:52:12Z

Cool stuff that you're adding, Philip 😍
Let us know when you're done...

pjsg · 2016-11-03T02:47:13Z

I should be done by friday -- I'm building an animated display as part of a hackathon project at work. It'll either work or not by Friday morning. Then I'l be done with ws2812!

pjsg · 2016-11-04T12:52:28Z

I'm good with this. I beat on it pretty hard yesterday and didn't find any issues.

marcelstoer · 2016-11-05T12:53:17Z

Then let's roll it in 😃

* add u8g.fb_rle display * move comm drivers to u8g_glue.c * disable fb_rle per default * implement file.size for spiffs (#1516) Another bug squashed! * Fix start-up race between UART & start_lua. (#1522) Input during startup (especially while doing initial filesystem format) ran the risk of filling up the task queue, preventing the start_lua task from being queued, and hence NodeMCU would not start up that time. * Reimplemented esp_init_data_default. To work around the pesky "rf_cal[0] !=0x05" hang when booting on a chip which doesn't have esp_init_data written to it. It is no longer possible to do the writing of the esp_init_data_default from within nodemcu_init(), as the SDK now hangs long before it gets there. As such, I've had to reimplement this in our user_start_trampoline and get it all done before the SDK has a chance to look for the init data. It's unfortunate that we have to spend IRAM on this, but I see no better alternative at this point. * Replace hardcoded init data with generated data from SDK The esp_init_data_default.bin is now extracted from the SDK (and its patch file, if present), and the contents are automatically embedded into user_main.o. * Rework flashing instructions Clarifies issues around SDK init data and hopefully clears up some confusion, when paired with the esp_init_data_default changes in NodeMCU. * Fix typo * Fixes the gpio.serout problem from #1534 (#1535) * Fix some issues in gpio.serout * Minor cleanup * fix dereferencing NULL pointer in vfs_errno() (#1539) * add map ids for flash sizes 32m-c2, 64m, 128m in user_rf_cal_sector_set() (#1529) * Somfy/TELIS driver (#1521) * Reduced LUAL_BUFFERSIZE to 256. Should free up some stack (#1530) * avoid task queue overrun for serial input (#1540) Thank you. * Increase irom0_0_seg size for PR build * Improve reliability of FS detection. (#1528) * Version to make filesystem detection more reliable * Improve bad fs detection * Version of printf that doesn't suffer from buffer overflows (#1564) * Small improvement to http client (#1558) * Remove luaL_buffer from file_g_read() (#1541) * remove luaL_buffer from file_g_read() - avoid memory leak when function gets terminated by lua_error - skip scanning for end_char when reading until EOF * attempt to free memory in any case * Change HTTP failures from debug to error messages (#1568) * Change HTTP failures from debug to error messages * Add tag to HTTP error messages * Create macro for error msg and improve dbg msg * Add ssd1306_128x32 for U8G (#1571) * Update CONTRIBUTING.md * Add support to mix ws2812.buffer objects. (#1575) * Add load/dump/mix/power operations on the buffer object * Calculate the pixel value in mix and then clip to the range. * Fixed the two wrong userdata types * Added a couple more useful methods * Add support for shifting a piece of the buffer. * Fix a minor bug with offset shifts * Update to the wifi module (#1497) * Removed inline documentation for several functions and update comments Since documentation is now part of the repository, the inline documentation just adds to the already huge wifi.c * Wifi module: add new functionality, update documentation Functions Added: wifi.getdefaultmode(): returns default wifi opmode wifi.sta.apchange(): select alternate cached AP wifi.sta.apinfo(): get cached AP list wifi.sta.aplimit(): set cached AP limit wifi.sta.getapindex(): get index of currently configured AP wifi.sta.getdefaultconfig(): get default station configuration wifi.ap.getdefaultconfig(): get default AP configuration functions modified: wifi.setmode: saving mode to flash is now optional wifi.sta.config: now accepts table as an argument and save config to flash is now optional wifi.sta.getconfig: added option to return table wifi.ap.config: save config to flash is now optional wifi.ap.getconfig: added option to return table Documentation changes: - Modified documentation to reflect above changes - Removed unnecessary inline documentation from `wifi.c` - Updated documentation for `wifi.sta.disconnect`to address issue #1480 - Fixed inaccurate documentation for function `wifi.sleeptype` - Added more details to `wifi.nullmodesleep()` * Move function `wifi.sleeptype()` to `wifi.sta.sleeptype()` * Fixed problem where wifi.x.getconfig() returned invalid strings when ssid or password were set to maximum length. * fix error in documentation for `wifi.sta.getapindex` * Renamed some wifi functions wifi.sta.apinfo -> getapinfo wifi.sta.aplimit -> setaplimit wifi.sta.apchange -> changeap also organized the wifi_station_map array * Make the MQTT PING functionality work better. (#1557) Deal with flow control stopped case * Implement object model for files (#1532) * Eus channelfix (#1583) Squashed commits included: Bug fixes and final implementation - Added Content-Length: 0 to all headers - Endpoint name checks not using trailing space so cache-busting techniques can be used (i.e., append a nonce to the URL) - Track when connecting so APList scan doesn't take place during (which changes the channel) - More debugging output added to assist in tracking down some issues Added /status.json endpoint for phone apps/XHR to get JSON response Station Status caching for wifi channel workaround + AJAX/CORS - During checkstation poll, cache the last station status - Shut down the station if status = 2,3,4 and channel is different than SoftAP - Add Access-Control-Allow-Origin: * to endpoint responses used by a service - Add a /setwifi GET endpoint for phone apps/XHR to use (same parameters as /update endpoint). Returns a JSON response containing chip id and status code. - Add handler for OPTIONS verb (needed for CORS support) Wi-Fi Channel Issue Workaround - Do a site survey upon startup, set SoftAP channel to the strongest rssi's channel - Compare successful station connect channel to SoftAP's. If different, then defer the Lua success callback to the end. Shut down Station and start the SoftAP back up with original channel. - After the 10 second shutdown timer fires, check to see if success callback was already called. If not, then call it while starting the Station back up. HTTP Response and DNS enhancements - If DNS's UDP buffer fills up, keep going as non-fatal. It's UDP and not guaranteed anyways. I've seen this occur when connecting a PC to the SoftAP and every open program tries to phone home at the same time, overwhelming the EUS DNS server. - Support for detecting/handling pre-gzipped `enduser_setup.html` (and `http_html_backup`) payload. Nice for keeping the size of the `state->http_payload_data` as small as possible (also makes minimization not as critical) - Corrected misuse of HTTP 401 response status (changed one occurrence to 400/Bad Request, and changed another to 405/Method Not Allowed) * Normalized formatting (tabs-to-spaces) * Added documentation * Corrected misuse of strlen for binary (gzip) data. * Added NULL check after malloc * fix vfs_lseek() result checking in enduser_setup and clarify SPIFFS_lseek() return value (#1570) * Fix link * Overhaul flashing docs once again (#1587) * Add chapter about determine flash size plus small fixes * Rewrite esptool.py chapter, move flash size chapter to end * i2c - allow slave stretching SCL (just loop and check) (#1589) * Add note on dev board usage of SPI bus 0 (#1591) * Turn SPI busses note to admonition note * support for custom websocket headers (#1573) Looks good to me. Thank you. Also: - allow for '\0's in received messages * add client:config for setting websocket headers Also: - headers are case-insensitive now * fix docs * fix typo * remove unnecessary luaL_argcheck calls * replace os_sprintf with simple string copy * Handle error condition in file.read() (#1599) * handle error condition in file.read() * simplify loop initialization * Fix macro as suggested in #1548 * Extract and hoist net receive callbacks This is done to avoid the accidental upval binding * Fix typo at rtctime.md rtctime.dsleep -> rtctime.dsleep_aligned

pjsg added 2 commits October 30, 2016 19:57

Add load/dump/mix/power operations on the buffer object

19e1720

Calculate the pixel value in mix and then clip to the range.

85ddc6d

marcelstoer added the new feature label Oct 31, 2016

devsaurus mentioned this pull request Nov 1, 2016

Generic buffer functionality #1579

Closed

devsaurus requested changes Nov 1, 2016

View reviewed changes

pjsg added 3 commits November 1, 2016 21:00

Fixed the two wrong userdata types

4852fbc

Added a couple more useful methods

e8c192d

Add support for shifting a piece of the buffer.

64a3b99

devsaurus approved these changes Nov 2, 2016

View reviewed changes

Fix a minor bug with offset shifts

c836c5a

Fixed the docs

342e504

marcelstoer added this to the Post-1.5.4.1-II milestone Nov 5, 2016

marcelstoer merged commit 77b2e85 into nodemcu:dev Nov 5, 2016

Add support to mix ws2812.buffer objects. #1575

Add support to mix ws2812.buffer objects. #1575

Uh oh!

Conversation

pjsg commented Oct 31, 2016

Uh oh!

devsaurus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pjsg Nov 2, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

devsaurus commented Nov 2, 2016

Uh oh!

pjsg commented Nov 3, 2016

Uh oh!

pjsg commented Nov 4, 2016

Uh oh!

marcelstoer commented Nov 5, 2016

Uh oh!

Uh oh!

pjsg Nov 2, 2016 •

edited

Loading