si_drivepars Struct Reference

Microstep drive parameter struct. More...

#include <siutils.h>

Data Fields
int	RS
	Drive status code (ready, moving, etc. see SCLReqStatus() or siutils.h).
int	RV
	Microstep drive firmware revision level.
int	PM
	Drive power-on mode (1=autodetect, 2=SCL mode only).
double	PC
	Drive power-on current in Amps.
double	CC
	Motor drive current in Amps.
double	CI
	Motor idle current in Amps.
double	VE
	Motor velocity (speed) in rev/s.
double	VC
	Motor change velocity (speed) in rev/s.
int	AC
	Motor acceleration in rev/s/s.
int	DE
	Motor deceleration in rev/s/s.
int	AM
	Motor maximum acceleration in rev/s/s.
int	DI
	Motor move distance in microsteps.
int	DC
	Motor distance-til-change in microsteps.
int	ID
	Motor immediate distance in microsteps (see also SCLGetDist()).
int	IP
	Motor immediate position in microsteps (see also SCLGetPos()).
char	IS [9]
	Immediate Status of the input lines (see also SCLInStatus()).
int	MR
	Microstep resolution code (values 3-15).
int	BS
	Drive buffer status, space in chars left in command buffer.
int	DL
	Limit status (1=normally open, 2=normally closed, 3=unused).
double	JS
	Jog speed in rev/s.
int	JA
	Jog acceleration in rev/s/s.

---

Detailed Description

Microstep drive parameter struct.

si_drivepars is a data structure that contains the complete set of drive parameters from an Applied Motion Products Si family microstep drive.

The si_drivepars struct member data names are the same as the corresponding parameters in the SCL command set. This should eliminate all ambiguity as to what things are called (why be different?).

Applications needing to know all the drive parameters at once declare a variable of type "si_drivepars_t" as the container, and can then query the drive status using the SCLGetParams() function. App programmers can then pick and choose which parameters are relevant.

For single parameters, calling SCLSendQuery() is much more efficient. Special calls for parameters requiring translation from text replies are also available (SCLGetPos(), SCLGetDist(), and SCLInStatus()).

See also:

SCLGetParams(), SCLSendQuery(), SCLGetPos(), SCLGetDist(), and SCLInStatus()

---

Field Documentation

int si_drivepars::RS

Drive status code (ready, moving, etc. see SCLReqStatus() or siutils.h).

int si_drivepars::RV

Microstep drive firmware revision level.

int si_drivepars::PM

Drive power-on mode (1=autodetect, 2=SCL mode only).

double si_drivepars::PC

Drive power-on current in Amps.

double si_drivepars::CC

Motor drive current in Amps.

double si_drivepars::CI

Motor idle current in Amps.

double si_drivepars::VE

Motor velocity (speed) in rev/s.

double si_drivepars::VC

Motor change velocity (speed) in rev/s.

int si_drivepars::AC

Motor acceleration in rev/s/s.

int si_drivepars::DE

Motor deceleration in rev/s/s.

int si_drivepars::AM

Motor maximum acceleration in rev/s/s.

int si_drivepars::DI

Motor move distance in microsteps.

int si_drivepars::DC

Motor distance-til-change in microsteps.

int si_drivepars::ID

Motor immediate distance in microsteps (see also SCLGetDist()).

int si_drivepars::IP

Motor immediate position in microsteps (see also SCLGetPos()).

char si_drivepars::IS[9]

Immediate Status of the input lines (see also SCLInStatus()).

int si_drivepars::MR

Microstep resolution code (values 3-15).

int si_drivepars::BS

Drive buffer status, space in chars left in command buffer.

int si_drivepars::DL

Limit status (1=normally open, 2=normally closed, 3=unused).

double si_drivepars::JS

Jog speed in rev/s.

int si_drivepars::JA

Jog acceleration in rev/s/s.

---

The documentation for this struct was generated from the following file:

• siutils.h

---