Difference between revisions of "SimpleMotion V2 API documentation"
From Granite Devices Knowledge Wiki
| [checked revision] | [checked revision] |
| Line 45: | Line 45: | ||
Ie V 2.5.1 would be 0x020501 and 1.2.33 0x010233}} | Ie V 2.5.1 would be 0x020501 and 1.2.33 0x010233}} | ||
| − | {{APIdoc|smbus smOpenBus( const char * devicename )|Open SM RS485 communication bus.}} | + | {{APIdoc|smbus|smOpenBus|( const char * devicename )|Open SM RS485 communication bus.}} |
;devicename: | ;devicename: | ||
:"USB2VSD" or com port as "COMx" where x=1-n, i.e. "COM15". In UNIX systems this is device path such as "/dev/ttyUSB0". | :"USB2VSD" or com port as "COMx" where x=1-n, i.e. "COM15". In UNIX systems this is device path such as "/dev/ttyUSB0". | ||
| Line 60: | Line 60: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | {{APIdoc|SM_STATUS smCloseBus( const smbus bushandle )|Close connection to given bus handle number. This frees communication link therefore makes it available for other apps for opening.}} | + | {{APIdoc|SM_STATUS|smCloseBus|( const smbus bushandle )|Close connection to given bus handle number. This frees communication link therefore makes it available for other apps for opening.}} |
;return value | ;return value | ||
:a SM_STATUS value, i.e. SM_OK if command succeed. The SM_STATUS return value from all other functions have similar meaning. | :a SM_STATUS value, i.e. SM_OK if command succeed. The SM_STATUS return value from all other functions have similar meaning. | ||
| Line 68: | Line 68: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | {{APIdoc|void smSetDebugOutput( smVerbosityLevel level, FILE *stream )|Set stream where debug output is written. By default nothing is written.}} | + | {{APIdoc|void|smSetDebugOutput|( smVerbosityLevel level, FILE *stream )|Set stream where debug output is written. By default nothing is written.}} |
;level | ;level | ||
:set verbosity level of debugging output. Enum choices are Off,Low,Mid,High and Trace. | :set verbosity level of debugging output. Enum choices are Off,Low,Mid,High and Trace. | ||
Revision as of 10:44, 9 August 2015
This page lists files and the API calls of SimpleMotion V2 C-library.
Files
- simplemotion.h
- The header file that declares API functions and constants used in SMV2 programs. Include this file in the C-file where SMV2 is used.
- simplemotion.dll or smv.dll
- A Win32 dynamic library. Place this file in application .exe folder if program is linked against the DLL. If project is being compiled with GNU GCC, then all library .c files may be added in the project to compile library statically in the program thus eliminate the need of .dll.
- simplemotion.lib or smv.lib
- A library file needed by some Microsoft C/C++ development tools to allow usage of DLL file. Most of other tools don't need these.
Types
SMV2 library uses custom integer types in order to have explicitly defined bit lengths. All types translate to standard C-types.
typedef long smbus; typedef unsigned long smuint32; typedef unsigned short smuint16; typedef unsigned char smuint8; typedef long smint32; typedef short smint16; typedef char smint8; typedef char smbool; #define smtrue 1 #define smfalse 0 typedef int SM_STATUS; typedef smuint8 smaddr; typedef enum _smVerbosityLevel {Off,Low,Mid,High,Trace} smVerbosityLevel;
SM_STATUS is returned by most of function calls and indicate the success or failure of the call. Multiple states are possible simultaneously, i.e. function may return integer value 40 which is a sum of 32 and 8 meaning both SM_ERR_COMMUNICATION and SM_ERR_LENGTH are active. Possible return values of SM_STATUS:
- SM_NONE (integer value 0)
- Never returned
- SM_OK (integer value 1)
- Call completed successfully
- SM_ERR_NODEVICE (integer value 2)
- Invalid smbus handle given or port not open
- SM_ERR_BUS (integer value 4)
- 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 EMI and Device connection troubleshooting)
- SM_ERR_PARAMETER (integer value 16)
- Illegal parameter value given
- SM_ERR_LENGTH (integer value 32)
- Command queue length exceeded maximum size or received return data length differs from expected length. Typical reasons: invalid/exceeded usage of queued commands or same as SM_ERR_COMMUNICATION reasons.
Functions
smuint32 smGetVersion() Return SM lib version number in hexadecimal format.
Ie V 2.5.1 would be 0x020501 and 1.2.33 0x010233
{{{3}}} ====Return SM lib version number in hexadecimal format. Ie V 2.5.1 would be 0x020501 and 1.2.33 0x010233====smbus smOpenBus( const char * devicename )
smOpenBus
Open SM RS485 communication bus.
- devicename
- "USB2VSD" or com port as "COMx" where x=1-n, i.e. "COM15". In UNIX systems this is device path such as "/dev/ttyUSB0".
- return value
- handle to be used with all other commands, -1 if fails
Usage:
smbus bushandle; bushandle=smOpenBus("COM5"); if(bushandle<0) { //error occurred }
SM_STATUS smCloseBus( const smbus bushandle )
smCloseBus
Close connection to given bus handle number. This frees communication link therefore makes it available for other apps for opening.
- return value
- a SM_STATUS value, i.e. SM_OK if command succeed. The SM_STATUS return value from all other functions have similar meaning.
Usage:
smCloseBus(bushandle);
void smSetDebugOutput( smVerbosityLevel level, FILE *stream )
smSetDebugOutput
Set stream where debug output is written. By default nothing is written.
- level
- set verbosity level of debugging output. Enum choices are Off,Low,Mid,High and Trace.
- stream
- A pointer to output stream such as stderr, stdout or a file handle.
