Changes between Initial Version and Version 1 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/IO/GetInput

Timestamp:

12/27/11 09:29:02 (13 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/ApplicationLibraries/lib825ev/IO/GetInput

@@ +1 @@
+= GetInput =
+Get a digital input state for the main board or a DIO option card.
+
+{{{
+bool GetInput(int bd, int input);
+}}}
+
+== Parameters ==
+
+ * bd - 0 for main board or number of digital output card.
+ * input - input number (1-4) main board (1-8) option card.
+
+== Return Value ==
+
+ * Returns the result - true = input is on, false = input is off
+
+== Remarks ==
+
+The main board or option card must already be opened by calling OpenMnBd first. This function returns the status of the memory buffer for the input. It is necessary to have communications code in place for this memory to be updated in an application. This can be done by using StartRepeatIO or StartRepeatMulti, at the beginning of the application or by calling MnBdRequest MNBD_GET_IO_STATUS prior to GetOutput.
+
+== Examples ==
+
+{{{
+if(GetInput(MNBD_DEV, 1) == true)
+    DisplayText(0, 0, "Input 1 is ON");
+}}}
+
+{{{
+if(GetInput(1, 4) == false)
+    DisplayText(0, 0, "Card 1 Input 4 is OFF");
+}}}
+
+== See Also ==
+
+ * [http://tech.825spectrum.com/trac/wiki/Docs/Prog/Manual/ApplicationLibraries/lib825ev/IO/SetOutput SetOutput]
+ * [http://tech.825spectrum.com/trac/wiki/Docs/Prog/Manual/ApplicationLibraries/lib825ev/IO/SetOutputMask SetOutputMask]