SimpleMotion V2 API documentation - Revision history

Tero K at 14:55, 9 December 2016

2016-12-09T14:55:23Z

Tero K at 11:47, 4 January 2016

2016-01-04T11:47:42Z

Tero K at 10:48, 4 January 2016

2016-01-04T10:48:51Z

Tero K at 21:58, 1 September 2015

2015-09-01T21:58:15Z

Show changes

Tero K at 21:53, 1 September 2015

2015-09-01T21:53:58Z

Tero K at 19:44, 1 September 2015

2015-09-01T19:44:37Z

Tero K at 19:41, 1 September 2015

2015-09-01T19:41:36Z

Show changes

Tero K: Text replacement - "{{param|EMI}}" to "EMI"

2015-08-28T19:58:48Z

Text replacement - "{{param|EMI}}" to "EMI"

Tero K: Text replacement - "\[\[([A-Z]{2,3})\]\]" to "{{param|$1}}"

2015-08-28T19:54:26Z

Text replacement - "\[\[([A-Z]{2,3})\]\]" to "{{param|$1}}"

Tero K at 18:44, 9 August 2015

2015-08-09T18:44:33Z

@@ Line 234: / Line 234: @@
 :{{SM_STATUS}}
 }}
 [[Category:SimpleMotion]]

@@ Line 225: / Line 225: @@
 }}
-{{APIdoc|SM_STATUS|smFastUpdateCycle|( smbus handle, smuint8 nodeAddress, smuint16 write1, smuint16 write2, smuint16 *read1, smuint16 *read2)|smFastUpdateCycle-function uses special SimpleMotion command to perform fast turaround communication. May be used with cyclic real time control. Written & read data content may be application & mode specific. This function may be called alone and it completes whole write & read cycle. |
+{{APIdoc|SM_STATUS|smFastUpdateCycle|( smbus handle, smuint8 nodeAddress, smuint16 write1, smuint16 write2, smuint16 *read1, smuint16 *read2)|smFastUpdateCycle-function uses special SimpleMotion command to perform fast turaround communication. May be used with cyclic real time control. Written & read data content may be application & mode specific. This function may be called alone and it completes whole write & read cycle. '''This function is under development, do not use before this notice removed.''' |
 ;handle
 :SimpleMotion bus handle as returned from smOpenBus

@@ Line 221: / Line 221: @@
 ;clock
 :Pointer to a 16 bit integer value where the clock time will be stored. Clock counter runs at 10 kHz meaning that 16 bit value will rollover every 6.5 seconds.
 ;Return value
 :{{SM_STATUS}}

@@ Line 85: / Line 85: @@
 Simple read & write of parameters commands. Single function call will perform all necessary communication with the target device, however this method is not as fast as the low level communication method (see chapter below).  Use these for non-time critical operations, such as initialization and point-to-point motion control where hard real-time control is not needed.
-{{APIdoc|SM_STATUS|smRead1Parameter|( const smbus handle, const smaddr nodeAddress, const smint16 paramId1, smint32 *paramVal1 )|Read one parameter value from the target device}}
+{{APIdoc|SM_STATUS|smRead1Parameter|( const smbus handle, const smaddr nodeAddress, const smint16 paramId1, smint32 *paramVal1 )|Read one parameter value from the target device|
 ;handle
 :SimpleMotion bus handle as returned from smOpenBus
@@ Line 96: / Line 96: @@
 ;Return value
 :{{SM_STATUS}}
+}}
 {{APIdoc|SM_STATUS|smRead2Parameters|( const smbus handle, const smaddr nodeAddress, const smint16 paramId1, smint32 *paramVal1,const smint16 paramId2, smint32 *paramVal2 )|Read two parameter value from the target device with a single function call, this executes faster than two calls of smRead1Parameter}}
 ;handle

@@ Line 92: / Line 92: @@
 ;paramId1
 :Integer value specifying the parameter address to be read. See list of SMP_xxx definitions from simplemotion_defs.h header file for possible parameters.
-;*paramVal1
+;paramVal1
 :Integer pointer where read parameter is stored
 ;Return value
@@ Line 104: / Line 104: @@
 ;paramId1
 :Integer value specifying the first parameter address to be read. See list of SMP_xxx definitions from simplemotion_defs.h header file for possible parameters.
-;*paramVal1
+;paramVal1
 :Integer pointer where the first read parameter is stored
 ;paramId2
 :Integer value specifying the second parameter address to be read. See list of SMP_xxx definitions from simplemotion_defs.h header file for possible parameters.
-;*paramVal2
+;paramVal2
 :Integer pointer where the second read parameter is stored
 ;Return value
@@ Line 120: / Line 120: @@
 ;paramId1
 :Integer value specifying the first parameter address to be read. See list of SMP_xxx definitions from simplemotion_defs.h header file for possible parameters.
-;*paramVal1
+;paramVal1
 :Integer pointer where the first read parameter is stored
 ;paramId2
 :Integer value specifying the second parameter address to be read. See list of SMP_xxx definitions from simplemotion_defs.h header file for possible parameters.
-;*paramVal2
+;paramVal2
 :Integer pointer where the second read parameter is stored
 ;paramId3
 :Integer value specifying the third parameter address to be read. See list of SMP_xxx definitions from simplemotion_defs.h header file for possible parameters.
-;*paramVal3
+;paramVal3
 :Integer pointer where the third read parameter is stored
 ;Return value
@@ Line 172: / Line 172: @@
 ;handle
 :SimpleMotion bus handle as returned from smOpenBus
-;*retValue
+;retValue
 :Pointer to a integer value where value if returning subpacket will be stored. {{SMPRET}}
 ;Return value
@@ Line 192: / Line 192: @@
 ;handle
 :SimpleMotion bus handle as returned from smOpenBus
-;*bytesinbuffer
+;bytesinbuffer
 :Pointer to a integer value where value of number of bytes will be stored
 ;Return value
@@ Line 201: / Line 201: @@
 ;handle
 :SimpleMotion bus handle as returned from smOpenBus
-;*clock
+;clock
 :Pointer to a 16 bit integer value where the clock time will be stored. Clock counter runs at 10 kHz meaning that 16 bit value will rollover every 6.5 seconds.
 ;Return value

@@ Line 35: / Line 35: @@
 :RS485 communication device error
 ;SM_ERR_COMMUNICATION (integer value 8)
-:Invalid reply or no reply received from target device. Typical reasons: inexisting nodeAddress given or signal quality problem (see {{param|EMI}} and [[Device connection troubleshooting]])
+:Invalid reply or no reply received from target device. Typical reasons: inexisting nodeAddress given or signal quality problem (see [[EMI]] and [[Device connection troubleshooting]])
 ;SM_ERR_PARAMETER (integer value 16)
 :Illegal parameter value given

@@ Line 1: / Line 1: @@
-This page lists files and the API calls of [[SimpleMotion V2]] C-library.
+{{WIP}}This page lists files and the API calls of [[SimpleMotion V2]] C-library.
 ==Files==
 ;simplemotion.h
@@ Line 105: / Line 105: @@
 {{APIdoc|SM_STATUS|smSetParameter|( const smbus handle, const smaddr nodeAddress, const smint16 paramId, smint32 paramVal )|}}
 {{APIdoc|SM_STATUS|smGetBufferClock|( const smbus handle, const smaddr targetaddr, smuint16 *clock )|}}
 [[Category:SimpleMotion]]