SPI example has non-sensical inclusion of math expression that's actually longer than the number it represents #80

rwaldron · 2016-07-15T21:35:26Z

var spi = new port.SPI({
  clockSpeed: 4*1000*1000, // 4MHz
  cpol: 1, // polarity
  cpha: 0, // clock phase
});

Is there a reason for assigning clockSpeed the value of an expression to be evaluated, versus just the number?

var spi = new port.SPI({
  clockSpeed: 4000000, // 4MHz
  cpol: 1, // polarity
  cpha: 0, // clock phase
});

Also, we should deprecate (with aliasing) clockSpeed, cpol and cphase in favor of parameters that are named something less hostile.

Recommending:

Old Name	New Name
clockSpeed	frequency
cpol	polarity
cpha	phase

jandrieu · 2016-09-07T18:01:43Z

Representing large numbers like 4,000,000 as 4*1000*1000 instead of 4000000 makes them easier to read, debug, and maintain.

I'd keep the clockspeed as it is, but I agree more readable property names for polarity and phase would be an improvement.

tcr · 2016-09-07T19:03:04Z

If we were using Java/Python/Rust, representing it as 4_000_000 would be ideal. ;) Since this is for docs, it probably if we show the audience clock speed can just be represented as 4000000. (Persons writing their own codebases can use the expanded *1000 forms. Different audience.)

+1 to polarity and phase. Where did terms CPHA and CPOL even come from? We probably sourced them from Arduino examples way back in the day, but I haven't really seen them used outside of that domain. (Also see "mode" etc.)

I feel like "clockSpeed" is more applicable than "frequency" but YMMV.

Smadattam · 2017-12-09T17:40:18Z

Hi guys, I'm new here, and am a pretty green programmer. Would it make sense to create a constant titled MHz (or some other descriptive name) instead, and set it equal to 1000x1000? That way the expression could become "4*MHz" which could be even more readable.

arushi019 · 2018-08-23T05:18:09Z

Hi @Frijol ! Can the issue be closed now that the pull request has been merged? Or is there something else that needs to be done?

Frijol · 2018-09-10T22:06:22Z

Yes, thanks for noticing!

rwaldron added the contribution-starter label Jul 15, 2016

arushi019 mentioned this issue Jul 31, 2018

Team DelSquared (RGSoC '18): Changed variable names #188

Merged

Frijol closed this Sep 10, 2018

Nov	DEC	Jan
	02
2019	2020	2021

tessel / t2-docs

SPI example has non-sensical inclusion of math expression that's actually longer than the number it represents #80

SPI example has non-sensical inclusion of math expression that's actually longer than the number it represents #80

rwaldron commented Jul 15, 2016

jandrieu commented Sep 7, 2016

tcr commented Sep 7, 2016 •

edited

Smadattam commented Dec 9, 2017 •

edited

arushi019 commented Aug 23, 2018 •

edited

Frijol commented Sep 10, 2018

tessel / t2-docs

Join GitHub today

GitHub is where the world builds software

SPI example has non-sensical inclusion of math expression that's actually longer than the number it represents #80

SPI example has non-sensical inclusion of math expression that's actually longer than the number it represents #80

Comments

rwaldron commented Jul 15, 2016

jandrieu commented Sep 7, 2016

tcr commented Sep 7, 2016 • edited

Smadattam commented Dec 9, 2017 • edited

arushi019 commented Aug 23, 2018 • edited

Frijol commented Sep 10, 2018

Essential cookies

Always active

Analytics cookies

tcr commented Sep 7, 2016 •

edited

Smadattam commented Dec 9, 2017 •

edited

arushi019 commented Aug 23, 2018 •

edited