Add LED matrix bindings for IS31FL3731 driver #1926

richlander · 2022-09-17T05:09:40Z

Used by:

Port of https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731.

Microsoft Reviewers: Open in CodeFlow

Ellerbach

Couple of comments. Also, we should have a discussion regarding simple things like Color. With changes in the graphic libs, we need to come with something simple we can use anywhere for consistency

src/devices/Is31fl3731/Bonnet16x8.cs

Ellerbach · 2022-10-04T08:40:48Z

src/devices/Is31fl3731/BreakoutRgb5x5.cs

+        /// <param name="r">Red brightness value 0->255.</param>
+        /// <param name="g">Green brightness value 0->255.</param>
+        /// <param name="b">Blue brightness value 0->255.</param>
+        public void WritePixelRgb(int x, int y, int r, int g, int b)


I know we are switching our graphic lib but we've been using Color in other bindings to pass colors. I would like to see that because of the predefined colors for example

Ellerbach · 2022-10-04T08:41:43Z

src/devices/Is31fl3731/Is31Fl3731.cs

+        // Command register
+        // Points pages one to nine
+        // table 2 in datasheet
+        private const byte COMMAND_REGISTER = 0xFD;


I'm a big fan of having all those in a Registers.cs file as an internal enum. It's much cleaner than using constants

Not sure about that. It's gonna make the code look pretty ugly without target typed enums.

Let's take a look.

This line:

Write(FUNCTION_REGISTER, DISPLAY_REGISTER, (byte)value);

Will turn into:

Write(Registers.FUNCTION_REGISTER, Registers.DISPLAY_REGISTER, (byte)value);

Right? I think that makes the C# look worse as compared to the Python code I read. Seems like this is trading cleanup at the top of the file for worse readability within the core logic.

I really prefer to use enums because they avoid problems. You can group them. And in this case have 2 different enums, one for the register and one for the command.
Short term const seems super nice. Then when it comes to maintenance, they are not good at all. Enums forces you to use the right one. Here on the Write function, I can use the wrong one very easilly.

So most likely your write will turn out like with 2 different enums. And when you have possibility to mix elements, it's much easier for maintenance and readability with enums:

Write(Function.FUNCTION_REGISTER, Register.DISPLAY_REGISTER, (byte)value);

I get it now. Thanks for explanation. Basically "type safety".

src/devices/Is31fl3731/Is31Fl3731.cs

Ellerbach · 2022-10-04T08:53:48Z

src/devices/Is31fl3731/LedShimRgb28x1.cs

+            (21, 0) => 15,
+            (_, 0) => x - 14,
+            // y == 1
+            (<2, 1) => 69 - x,


you're missing some spaces in the following lines

Ellerbach · 2022-10-04T08:54:14Z

src/devices/Is31fl3731/LedShimRgb28x1.cs

+        /// <param name="r">Red brightness value 0->255.</param>
+        /// <param name="g">Green brightness value 0->255.</param>
+        /// <param name="b">Blue brightness value 0->255.</param>
+        public void WritePixelRgb(int x, int r, int g, int b)


Same feedback as for the other one: usage of Color

richlander · 2022-11-07T06:37:49Z

I need to re-test all the devices and then I'll switch this PR to "Ready for review".

Ellerbach · 2022-11-07T11:36:08Z

src/devices/Is31fl3731/Is31fl3731.cs

+        // Command register
+        // Points pages one to nine
+        // table 2 in datasheet
+        private const byte COMMAND_REGISTER = 0xFD;


rather than private const, a nice enum is always preferable especially in that case where you have quite a lot of them.

I raised a concern on that. What are your thoughts? This is the official Python implementation: https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731/blob/main/adafruit_is31fl3731/__init__.py

#1926 (comment)

I commented then on the other comment.

I took your advice.

I first tried enums. That looked pretty rough to me since I had to add a cast at every callsite: f3c7b63

I then switched to static classes. That resolved the issue: ecd652f

I left the API signatures as byte. The reason is that there are multiple registers and their values overlap. Also, one of the registers takes values 0-7 for 8 pages of data. Forcing the use of an enum or static class to iterate from 0..7 doesn't make much sense.

Seem better?

richlander · 2022-11-30T02:17:17Z

This link seems to consistently fail.

Ellerbach · 2022-12-03T09:24:00Z

src/devices/Is31fl3731/Registers.cs

+    /// </summary>
+    // Enables pages one to nine
+    // Table 2 in datasheet
+    public static class CommandRegister


why public cstatic lasses and not enums? you don't seem to override them or anything like this.

Ellerbach · 2022-12-03T09:25:27Z

src/devices/Is31fl3731/samples/Program.Matrix.cs

+// https://www.adafruit.com/product/2974
+using I2cDevice i2cDevice = I2cDevice.Create(new I2cConnectionSettings(busId: 1, Backpack16x9.DefaultI2cAddress));
+Backpack16x9 matrix = new(i2cDevice);
+// For 16x8 matrix Charlieplex bonet


maybe itroduce an empty line between each block of matrix? you can as well use 4 slash or dashes or anything to make it more redable

Good call. Done.

Ellerbach

Very minor comments, all look very nice :-) mpatient to buy few of those and find time to use them :-)

pgrawehr

Few comments that (I think) explain the build failures.

pgrawehr · 2022-12-04T15:14:56Z

src/devices/Is31fl3731/samples/MatrixRgb.sample.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">


Please put all sample projects into separate folder (samples\sample1, samples\sample2, etc.). Having multiple .csproj files in the same folder causes problems on macos due to a compiler bug.

I believe that there are multiple bindings that have that problem. Is this our new policy?

pgrawehr · 2022-12-04T15:15:29Z

src/devices/Is31fl3731/samples/LedShim28x1.sample.csproj

+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFrameworks>net60</TargetFrameworks>


TFM must be net6.0

pgrawehr · 2022-12-04T15:15:56Z

src/devices/Is31fl3731/samples/MatrixRgb.sample.csproj

+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFrameworks>net60</TargetFrameworks>


TFM must be net6.0.

ghost · 2022-12-11T17:01:44Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 7 days.

richlander · 2022-12-14T03:09:59Z

I just looked through the logs. None of the errors seem related to this PR.

pgrawehr · 2023-01-12T08:43:08Z

This needs a conflict resolution.

richlander added 6 commits September 13, 2022 22:42

Add IS31FL3731 LED matrix binding

9467d62

Update sample

afc27f6

Make program more generic

0b967c8

Add specific bindings

f85b07e

Add Phat 17x7 binding

afe92b9

Add Phat 17x7 binding

524220d

ghost added the area-device-bindings Device Bindings for audio, sensor, motor, and display hardware that can used with System.Device.Gpio label Sep 17, 2022

richlander and others added 4 commits September 18, 2022 22:10

Add LED Shim 28x1 driver

a2f6331

Update switch expression

b487223

Update TPN

2521cd0

Add README

5cdf122

richlander changed the title ~~Add LED matrix bindings for ISs31FL3731 driver~~ Add LED matrix bindings for IS31FL3731 driver Sep 19, 2022

richlander and others added 7 commits September 20, 2022 08:40

Add Led Matrix Breakout 11x7 binding

1833ef5

Update README for led matrix breakout

693c89a

Add Led RGB Matrix 5x5 binding

6df597c

Add 5x5 RGB Matrix sample

ed4c7b1

Switch integers to decimals

976acc1

Fix syntax

83c1a35

Rename type

368ddd7

Ellerbach reviewed Oct 4, 2022

View reviewed changes

Update per feedback

321a8d6

richlander added 2 commits November 6, 2022 22:40

Merge branch 'main' into Is31Fl3731

7551681

Update per feedback

86f314c

Ellerbach reviewed Nov 7, 2022

View reviewed changes

richlander added 3 commits November 25, 2022 16:51

Merge branch 'main' into Is31Fl3731

2c3908c

Switch to enums for const data

f3c7b63

Switch from enum to static class

ecd652f

richlander marked this pull request as ready for review November 30, 2022 02:17

Ellerbach reviewed Dec 3, 2022

View reviewed changes

Ellerbach approved these changes Dec 3, 2022

View reviewed changes

Merge branch 'main' into Is31Fl3731

6e9e51b

pgrawehr requested changes Dec 4, 2022

View reviewed changes

ghost added the Needs: Author Feedback We are waiting for author to react to feedback (action required) label Dec 4, 2022

ghost added the Status: No Recent Activity label Dec 11, 2022

ghost removed Needs: Author Feedback We are waiting for author to react to feedback (action required) Status: No Recent Activity labels Dec 13, 2022

richlander added 7 commits December 12, 2022 22:04

Update blinking

9cc426d

Add 'Port of' comments

446a945

Update sample

aed674f

Update sample

0dd3014

Update comment

234f652

Update per feedback

da63455

Add 'Port of' comment

1db4862

pgrawehr mentioned this pull request Dec 25, 2022

Add binding for IS31FL3730 LED driver #1930

Merged

joperezr assigned richlander Jan 5, 2023

joperezr requested a review from pgrawehr January 5, 2023 16:48

richlander added 3 commits January 11, 2023 20:36

Move samples to directories

d2fca8b

Update README

5103777

Change exception type

e599776

pgrawehr approved these changes Jan 12, 2023

View reviewed changes

Merge branch 'main' into Is31Fl3731

1027c92

richlander merged commit 2580229 into dotnet:main Jan 16, 2023

richlander deleted the Is31Fl3731 branch January 16, 2023 20:40

github-actions bot locked and limited conversation to collaborators Dec 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add LED matrix bindings for IS31FL3731 driver #1926

Add LED matrix bindings for IS31FL3731 driver #1926

richlander commented Sep 17, 2022 •

edited

Loading

Ellerbach left a comment

Ellerbach Oct 4, 2022

richlander Nov 7, 2022

Ellerbach Oct 4, 2022

richlander Nov 7, 2022

Ellerbach Nov 7, 2022

richlander Nov 12, 2022

Ellerbach Oct 4, 2022

richlander Nov 7, 2022 •

edited

Loading

Ellerbach Oct 4, 2022

richlander Nov 7, 2022

richlander commented Nov 7, 2022

Ellerbach Nov 7, 2022

richlander Nov 7, 2022 •

edited

Loading

Ellerbach Nov 7, 2022

richlander Nov 30, 2022

richlander commented Nov 30, 2022

Ellerbach Dec 3, 2022

Ellerbach Dec 3, 2022

richlander Dec 14, 2022

Ellerbach left a comment

pgrawehr left a comment

pgrawehr Dec 4, 2022

richlander Dec 14, 2022

pgrawehr Dec 4, 2022

pgrawehr Dec 4, 2022

ghost commented Dec 11, 2022

richlander commented Dec 14, 2022

pgrawehr commented Jan 12, 2023

Add LED matrix bindings for IS31FL3731 driver #1926

Add LED matrix bindings for IS31FL3731 driver #1926

Conversation

richlander commented Sep 17, 2022 • edited Loading

Microsoft Reviewers: Open in CodeFlow

Ellerbach left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richlander Nov 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richlander commented Nov 7, 2022

Choose a reason for hiding this comment

richlander Nov 7, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richlander commented Nov 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ellerbach left a comment

Choose a reason for hiding this comment

pgrawehr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Dec 11, 2022

richlander commented Dec 14, 2022

pgrawehr commented Jan 12, 2023

richlander commented Sep 17, 2022 •

edited

Loading

richlander Nov 7, 2022 •

edited

Loading

richlander Nov 7, 2022 •

edited

Loading