Skip to content

Commit 8c51d7a

Browse files
committed
Beautify readme text.
1 parent dbd3556 commit 8c51d7a

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -866,12 +866,14 @@ Functions that exchange data with the MachineMotion controller (no movement invo
866866

867867
**IMPORTANT:**
868868
The following interfaces:
869+
869870
- attachControlDevice(port, device, callback)
870871
- detachControlDevice(port, callback)
871872
- readControlDevice(port, signal, callback)
872873
- writeControlDevice(port, signal, callback)
873874

874875
have been obsoleted and replaced with:
876+
875877
- isIoExpanderAvailable( device )
876878
- digitalRead( device, pin )
877879
- digitalWrite( device, pin )
@@ -882,7 +884,7 @@ have been obsoleted and replaced with:
882884

883885
Determines if the io-expander with the given id is available
884886

885-
@param device - The io-expander device identifier
887+
@param device - The io-expander device identifier
886888
@return - True if the io-expander exists; False otherwise
887889

888890
#### Example
@@ -906,9 +908,9 @@ if ( machine_motion_example.isIoExpanderAvailable( io_expander_id ) ):
906908

907909
Read the digital input from the given pin in put on the IO Expander
908910

909-
@param device - The IO expander device identifier (1-3)
910-
@param pin. - The pin index to read from (0-3)
911-
@return. - The level at the IO expander pin
911+
@param device - The IO expander device identifier (1-3)
912+
@param pin. - The pin index to read from (0-3)
913+
@return. - The level at the IO expander pin
912914

913915
#### Example
914916

@@ -930,9 +932,9 @@ pinValue = machine_motion_example.digitalRead( io_expander_id , input_pin )
930932

931933
Modify the digital output of the given pin a the specified device.
932934

933-
@param device - The IO expander device identifier (1-3)
934-
@param pin. - The pin index to write to (0-3)
935-
@param value - The pin value to be written
935+
@param device - The IO expander device identifier (1-3)
936+
@param pin. - The pin index to write to (0-3)
937+
@param value - The pin value to be written
936938

937939
#### Example
938940

@@ -954,8 +956,8 @@ machine_motion_example.digitalWrite( io_expander_id , input_pin, 0 )
954956

955957
Returns the realtime position of the given encoder.
956958

957-
@param encoder - The identifier of the encoder (0-2).
958-
@return - The relatime encoder position (deled by up to 250ms)
959+
@param encoder - The identifier of the encoder (0-2)
960+
@return - The relatime encoder position (deled by up to 250ms)
959961

960962
**NOTE:** The encoder position return may be offset by up to 250ms caused by internal propagation delays
961963

0 commit comments

Comments
 (0)