tmimsp: clean up open drain for sht1x DATA

[tinyos-2.x.git] / tos / platforms / tmimsp / tmirws / chips / sht11 / OpenDrainC.nc

diff --git a/tos/platforms/tmimsp/tmirws/chips/sht11/OpenDrainC.nc b/tos/platforms/tmimsp/tmirws/chips/sht11/OpenDrainC.nc
index e89e26f34685c0b1e634776111164f685cb6044d..f8de2aa3d26b70503d69bb9e3e155f5275a25c56 100644 (file)
--- a/tos/platforms/tmimsp/tmirws/chips/sht11/OpenDrainC.nc
+++ b/tos/platforms/tmimsp/tmirws/chips/sht11/OpenDrainC.nc
@@ -28,8 +28,14 @@
  */
 
 /**
- * Implement an open drain output using a GeneralIO, represented as a
- * GeneralIO.  Requires an external pull-up for proper operation.
+ * Provide an open drain output as a GeneralIO using a GeneralIO.
+ *
+ * set() puts the pin in high impedance state by selecting the pin input mode.
+ * clr() sets the pin to sink current to ground by selecting the pin output
+ * mode, logic zero.  Generally, an external pull-up resistor will be used with
+ * an open drain output.
+ *
+ * This pin can only be an open drain output and cannot be reconfigured.
  *
  * @author R. Steve McKown <rsmckown@gmail.com>
  */