Alion3064492356
commented
6 years ago A. Okay, I agree to rename 3ColorLED to RGB_SMD_LED, but I think it is better to add (3colorLed) after RGB_SMD_LED like RGB_SMD_LED(3colorLed), for the reason that this module's name is 3colorLed in our product list, and It will not be modified for the moment. B. It's ok to rename Read Me First.xt as 00_ReadMe.txt. C.It's better to exchange reedSwitch with miniReedSwitch in numeric folder order. D.I think we could locate analogTempSensor, digitalTempSensor, ds18b20 and DHT11 together and put them to the end for the reason that ds18b20 and DHT11 are much hard to learn. E.We could rename DHT11 to tempHumiditySensor as the way to rename 3ColorLED . F.I absolutely agree your suggestions.
njackiw
Nick would like to make some changes to the sensor folder order and document names to improve clarity and easy of use. Please discuss and add COMMENTS to this issue letting me know whether Kuman is okay with me making these changes. (You can approve or reject changes individually.) I would like to make them all in one pass, near the end of the process, so I can update various pieces that depend on them at the same time.
A. Rename 3ColorLED to either RGB_SMD_LED or miniRGB_LED.
Reason: consistency. The 3ColorLED is the same thing as the RGB_LED, just smaller. It is NOT like the 2ColorLED or 7ColorLED -- which meaningfully produce only two or seven colors --- instead it is meant to produce many colors out of R, G, B combinations. Renaming it to RGB_SMD_LED correctly describes it as like the RGB_LED but different by virtue of SMD packaging; renaming it to miniRGB_LED correctly describes it as like the RBG_LED but different by virtue of being smaller. (Both are true. We elsewhere already use the XXX and miniXXX naming convention with reed switches.)
B. Rename Read Me First.xt as 00_ReadMe.txt.
Rationale: this way it will appear before all sensor folders in any alphabetized list.
Afterwards, scan documents to make sure no one mentions ReadMeFirst.txt
C. Exchange reedSwitch with miniReedSwitch in numeric folder order. The mini-reed switch is the easiest (most understandable) magnetic sensor to start with; users should encounter it before the non-mini one. (Even better would be to rename miniReedSwitch as simply reedSwitch, and rename the old reedSwitch as compoundReedSwitch or analogReedSwitch once I understand what it is----see #12!)
D. Rename analogTempSensor, digitalTempSensor, and ds18b20 to three names that make sense together, and reorder folders so that all three are located together.
Rationale: All three are temperature sensors; we should group them together for better user understanding. Current names are confusing --- what is ds18b20? --- and not very accurate. The analogTempSensor is clearly analog: it provides analog output, not digital output. The ds18b20 is clearly digital: it provides digital output, not analog output. The one currently called digitalTempSensor is confusing; it provides both analog and digital inputs, but its current description gives no context for what the meaning of the digital signal might be or when temperature can be said to have "flipped."
E. Rename DHT11 to tempHumiditySensor and reorder so its folder is located next to the temperature sensors, above.
Rationale: All our other folder names are named descriptively, rather than by component identification codes. This is a temperature and humidity sensor and could be called such.
F. Rename things for consistent capitalization and punctuation.
Most of our folder and document names use mixed camelCase, without spaces or underscores, with an exception for the two-digit sensor folder index number, which is separated from the sensor name by an underscore. Thus 06_buttonSwitch or 17_photoResistor are correct examples. Exceptions include acronyms (which should be all caps, like RGB or LED).
Examples of things we'd rename for consistency here: 15_8segment_digital_tube -> 15_8segmentDigitalTube; 19_TouchSensor -> 19_touchSensor; etc.