feature - update documentation for the latest #41
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CleoQc
previously requested changes
Apr 3, 2018
| """ | ||
| If the port configuration got reset, call this method to reconfigure it. | ||
|
|
||
| The idea is that in case the `InertialMeasurementUnit Sensor`_ gets pulled out of the plug or if there's an error on then |
| @@ -131,6 +155,17 @@ def safe_read_euler(self): | |||
| return x,y,z | |||
|
|
|||
| def safe_read_magnetometer(self): | |||
There was a problem hiding this comment.
those "safe" methods should be renamed to "easy" methods. They were written before it was decided to create an easy module . What do you think?
|
|
||
| This class compared to :py:class:`~di_sensors.light_color_sensor.LightColorSensor` uses mutexes that allows a given | ||
| object to be accessed simultaneously from multiple threads/processes. | ||
| Apart from this difference, there may |
| """ | ||
| Constructor for initializing a link to the `Light Color Sensor`_. | ||
|
|
||
| :param str bus = "I2C-1": The bus to which the distance sensor is connected to. Check the :ref:`hardware specs <hardware-interface-section>` for more information about the ports. |
| Constructor for initializing a link to the `Light Color Sensor`_. | ||
|
|
||
| :param str bus = "I2C-1": The bus to which the distance sensor is connected to. Check the :ref:`hardware specs <hardware-interface-section>` for more information about the ports. | ||
| :param bool led_state = False: The LED state. If it's set to ``True``, then the LED will turn on, otherwise the LED will stay off. By default, the LED is turned on. |
There was a problem hiding this comment.
the default is False, hence the LED is off
| Returned values are h (0-360), s (0-100), v(0-100) | ||
| ''' | ||
| """ | ||
| Standard algorithm to switch from one color system (**RGB**) to another (**HSV**). |
There was a problem hiding this comment.
Can we add a link to https://www.kirupa.com/design/little_about_color_hsv_rgb.htm here?
There was a problem hiding this comment.
We already did it.
| def get_safe_raw_colors(self, use_mutex=True): | ||
| def get_safe_raw_colors(self): | ||
| """ | ||
| Returns the color read off of the `Light Color Sensor`_. |
There was a problem hiding this comment.
Can we add that these colors are highly influenced by surrounding lighting?
| """ | ||
| Constructor for initializing link with the `Temperature Humidity Pressure Sensor`_. | ||
|
|
||
| :param str port = "I2C-1": The bus to which the THP sensor is connected to. By default, it's set to bus ``"I2C-1"``. Check the :ref:`hardware specs <hardware-interface-section>` for more information about the ports. |
CleoQc
approved these changes
Apr 5, 2018
|
As we're pressed by time, I'm going to ignore my request for John's review. |
CleoQc
reviewed
Apr 6, 2018
| status = -1 | ||
| finally: | ||
| ifMutexRelease(self.use_mutex) | ||
| return status | ||
|
|
||
| def get_heading(self, in_heading): | ||
| def safe_heading(self): |
There was a problem hiding this comment.
Why was the parameter removed from get_heading now called safe_heading?
CleoQc
pushed a commit
that referenced
this pull request
Apr 26, 2018
* Add Line Follower drivers and example * Update dexter_i2c.py Update dexter_i2c.py to be simpler and more universal by combining functions. * Update line_follower.py Update line_follower.py for recent dexter_i2c.py update * Feature/easy libraries (#35) * Move Distance Sensor and Line Follower in here * remove dependency on mock_package * remove alias for read_sensors until we know if we need it (probably not) * Feature/system wide mutex+ easydi_sensors library (#36) * Move Distance Sensor and Line Follower in here * remove dependency on mock_package * remove alias for read_sensors until we know if we need it (probably not) * get easydi_sensors from DexterOS * Check for overall mutex need * Add systemwide mutex comment * Add license header and description * Add license header * change year in license header * split easydi_sensors into 3 components for systematic naming convention * Remove copies of ifMutexAcquire and ifMutexRelease. Keep them in one file * Be more strict in what we're pulling in from easy_mutex * poll overall_mutex each time * remove print statement (#37) reconfig_bus() is now mutex protected * feature - update documentation for the latest (#41) * feature - configuring the environment for RTD * feature - bulk changes to docs * feature - add comment on how to build documentation * feature - add part of the documentation * feature - completing the documentation for easy sensors + tutorials * feature - work on the tutorials + other stuff * feature - fix the mutexes tutorial * feature - change organization of documentation * feature - remove an unnecessary section * feature - show the right command for installing di-sensors * feature - small changes * feature - fix documentation & and missing parts * feature - fix naming of the package * Revert commit * minor fixes to docs (#42) * minor fixes to docs * minor fixes to doc * fix grammar * rename safe_heading to heading_name and re-instate the parameter (#43) * rename safe_heading to heading_name and re-instate the parameter * rename from heading_name to convert_heading * add punctuation * fix - change name of method in library description section * Remove references to line follower (#45)
RobertLucian
added a commit
that referenced
this pull request
Jun 1, 2018
* Add Line Follower drivers and example * Update dexter_i2c.py Update dexter_i2c.py to be simpler and more universal by combining functions. * Update line_follower.py Update line_follower.py for recent dexter_i2c.py update * Feature/easy libraries (#35) * Move Distance Sensor and Line Follower in here * remove dependency on mock_package * remove alias for read_sensors until we know if we need it (probably not) * Feature/system wide mutex+ easydi_sensors library (#36) * Move Distance Sensor and Line Follower in here * remove dependency on mock_package * remove alias for read_sensors until we know if we need it (probably not) * get easydi_sensors from DexterOS * Check for overall mutex need * Add systemwide mutex comment * Add license header and description * Add license header * change year in license header * split easydi_sensors into 3 components for systematic naming convention * Remove copies of ifMutexAcquire and ifMutexRelease. Keep them in one file * Be more strict in what we're pulling in from easy_mutex * poll overall_mutex each time * remove print statement (#37) reconfig_bus() is now mutex protected * feature - update documentation for the latest (#41) * feature - configuring the environment for RTD * feature - bulk changes to docs * feature - add comment on how to build documentation * feature - add part of the documentation * feature - completing the documentation for easy sensors + tutorials * feature - work on the tutorials + other stuff * feature - fix the mutexes tutorial * feature - change organization of documentation * feature - remove an unnecessary section * feature - show the right command for installing di-sensors * feature - small changes * feature - fix documentation & and missing parts * feature - fix naming of the package * Revert commit * minor fixes to docs (#42) * minor fixes to docs * minor fixes to doc * fix grammar * rename safe_heading to heading_name and re-instate the parameter (#43) * rename safe_heading to heading_name and re-instate the parameter * rename from heading_name to convert_heading * add punctuation * fix - change name of method in library description section * Remove references to line follower (#45) * feature - add old line follower in (#46) * feature - adding in the line follower and making basic fixes and adjusts * feature - fixing paths * feature - import both versions of the line follower * feature - change paths accordingly * feature - fix path issues with di_sensors * feature - fix path issues * feature - check if installer runs on GUI-enabled OS * feature - yet another path issue fixed * feature - go back to using the same import for the line follower * feature - import line_sensor correctly in new module * feature - fix the paths yet again * feature - add python-periphery as required packafe for line follower * feature - change how the installation of the sensors goes (#48) * feature - add installer script for di-sensors * feature - add install requires for python-periphery * feature - use the name of the module when identifying the python package * feature - resize logo to a better aspect ratio * feature - adjust simple install command * feature - add readme in installation directory * feature - modify repo readme * feature - fix global variable issue * feature - change how the installation goes * feature - add the red line follower to the installation * feature - call configure function for the red line follower * feature - add/remove feedback instructions in install script * feature - change version of red line follower to 1.0.0 * fix Line Follower Calibration GUI (#49) * fix - install sources (#50) * fix - fix path issue for desktop icon (#51) * feature - change references for script_tools (#52) * fix Line Follower Calibration GUI * Fix path to line_sensor_gui in the desktop file * feature - change references for script_tools * use direct links instead of redirects
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here's the long-awaited documentation for the DI-Sensors library.
@CleoQc @johnisanerd please check every section of this documentation and give it a good read. There had been quite a lot of changes, so we'd better be sure the documentation is good.
A link to the documentation can be found here: http://di-sensors-mine.readthedocs.io/en/feature-docs/index.html. It's a private project, so no one else can see it unless they've got a link to it.