Configuring Calibration, IP Address, and Cable ID
Detailed Description
These functions allow you to read and set the scanner's calibration, IP address configuration, and Cable ID.
|
Functions |
| JCAM_DLL_API int STDCALL | jsReadOldPositionCalibrationsN (JCONNECTION const jc, jsLaserIndex const laserIndex, jsOldCalibrationValue oldCalibrations[], UINT32 nCalibrations) |
| | Reads the specified number of old position calibrations for the selected laser from the scanner.
|
| JCAM_DLL_API int STDCALL | jsReadPositionCalibrationN (JCONNECTION const jc, jsLaserIndex const laserIndex, double *xOffset, double *yOffset, double *roll) |
| | Reads the current position calibration for the selected laser from the scanner.
|
| JCAM_DLL_API int STDCALL | jsSendPositionCalibrationN (JCONNECTION const jc, jsLaserIndex const laserIndex, double const xOffset, double const yOffset, double const roll) |
| | Sends a position calibration for the selected laser to the scanner.
|
| JCAM_DLL_API int STDCALL | jsSetStaticIpInt (UINT32 const serialNumber, UINT32 const staticIpAddress, UINT32 const netmask) |
| | Sets a scanner's static IP address.
|
| JCAM_DLL_API int STDCALL | jsSetStaticIpChar (UINT32 const serialNumber, char const *const staticIpAddress, char const *const netmask) |
| | Sets a scanner's static IP address.
|
| JCAM_DLL_API int STDCALL | jsSetBaseIpInt (UINT32 const serialNumber, UINT32 const baseIpAddress, UINT32 const netmask) |
| | Sets a scanner's base IP address.
|
| JCAM_DLL_API int STDCALL | jsSetBaseIpChar (UINT32 const serialNumber, char const *const baseIpAddress, char const *const netmask) |
| | Sets a scanner's base IP address.
|
| JCAM_DLL_API int STDCALL | jsSetCableId (UINT32 const serialNumber, UINT32 const cableId) |
| | Overrides the cable ID physically wired into a scanner.
|
| JCAM_DLL_API int STDCALL | jsClearCableId (UINT32 const serialNumber) |
| | Reverts to the cable ID physically wired into a scanner.
|
Function Documentation
|
|
Reads the specified number of old position calibrations for the selected laser from the scanner.
- See also:
jsSendPositionCalibrationN()
jsReadPositionCalibrationN()
- Parameters:
-
| jc | The connection to the scanner. |
| laserIndex | Which laser to read the position calibration for. |
| oldCalibrations | An array of jsOldCalibrationValue objects to store the old calibrations in. |
| nCalibrations | The number of elements in jsOldCalibrationValue. |
- Returns:
- The number of calibrations read on success.
0 if there are no old calibrations.
INVALID_PARAMETER if jc or oldCalibrations NULL or if laserIndex is invalid.
SCANNER_FAILURE on all connection failures.
|
| JCAM_DLL_API int STDCALL jsReadPositionCalibrationN |
( |
JCONNECTION const |
jc, |
|
|
jsLaserIndex const |
laserIndex, |
|
|
double * |
xOffset, |
|
|
double * |
yOffset, |
|
|
double * |
roll |
|
) |
|
|
|
|
Reads the current position calibration for the selected laser from the scanner.
- See also:
jsSendPositionCalibrationN()
jsReadOldPositionCalibrationsN()
- Since:
- Revision 1932
- Parameters:
-
| jc | The connection to the scanner. |
| laserIndex | Which laser to read the position calibration for. |
| xOffset | Stores the value of the scanner's x offset. |
| yOffset | Stores the value of the scanner's y offset. |
| roll | Stores the value of the scanner's rotation. |
- Returns:
- 0 on success.
INVALID_PARAMETER if jc, xOffset, yOffset, or roll is NULL.
SCANNER_FAILURE on all connection failures.
|
| JCAM_DLL_API int STDCALL jsSendPositionCalibrationN |
( |
JCONNECTION const |
jc, |
|
|
jsLaserIndex const |
laserIndex, |
|
|
double const |
xOffset, |
|
|
double const |
yOffset, |
|
|
double const |
roll |
|
) |
|
|
|
|
Sends a position calibration for the selected laser to the scanner.
- See also:
jsReadPositionCalibrationN()
jsReadOldPositionCalibrationsN()
- Parameters:
-
| jc | The connection to the scanner. |
| laserIndex | Which laser to send the position calibration for. |
| xOffset | The new value of the scanner's x offset. |
| yOffset | The new value of the scanner's y offset. |
| roll | The new value of the scanner's rotation. |
- Returns:
- 0 on success.
INVALID_PARAMETER if jc is NULL.
SCANNER_FAILURE on all connection failures.
|
| JCAM_DLL_API int STDCALL jsSetStaticIpInt |
( |
UINT32 const |
serialNumber, |
|
|
UINT32 const |
staticIpAddress, |
|
|
UINT32 const |
netmask |
|
) |
|
|
|
|
Sets a scanner's static IP address.
The IP address will be static; it will not depend on the Cable ID of the scanner. If the scanner is moved to a different location with a different Cable ID, it will have the same IP address.
- Parameters:
-
| serialNumber | The serial number of the scanner whose IP address you want to set. |
| staticIpAddress | Must be in network byte order. An integer representing the IP address the scanner will use. |
| netmask | Must be in network byte order. An integer representing the IP netmask the scanner will use. |
- Returns:
- 0 on success.
-1 on all failures.
|
| JCAM_DLL_API int STDCALL jsSetStaticIpChar |
( |
UINT32 const |
serialNumber, |
|
|
char const *const |
staticIpAddress, |
|
|
char const *const |
netmask |
|
) |
|
|
|
|
Sets a scanner's static IP address.
The IP address will be static; it will not depend on the Cable ID of the scanner. If the scanner is moved to a different location with a different Cable ID, it will have the same IP address.
- Parameters:
-
| serialNumber | The serial number of the scanner whose IP address you want to set. |
| staticIpAddress | The IP address the scanner will use. |
| netmask | The IP netmask the scanner will use. |
- Returns:
- 0 on success.
INVALID_PARAMETER if baseIpAddress or netmask is NULL or invalid.
-1 on all other failures.
|
| JCAM_DLL_API int STDCALL jsSetBaseIpInt |
( |
UINT32 const |
serialNumber, |
|
|
UINT32 const |
baseIpAddress, |
|
|
UINT32 const |
netmask |
|
) |
|
|
|
|
Sets a scanner's base IP address.
The IP address will be determined by adding the scanner's Cable ID to the base IP address.
- Parameters:
-
| serialNumber | The serial number of the scanner whose IP address you want to set. |
| baseIpAddress | Must be in network byte order. An integer representing the base IP address the scanner will use to determine its final IP address. |
| netmask | Must be in network byte order. An integer representing the IP netmask the scanner will use. |
- Returns:
- 0 on success.
-1 on all failures.
|
| JCAM_DLL_API int STDCALL jsSetBaseIpChar |
( |
UINT32 const |
serialNumber, |
|
|
char const *const |
baseIpAddress, |
|
|
char const *const |
netmask |
|
) |
|
|
|
|
Sets a scanner's base IP address.
The IP address will be determined by adding the scanner's Cable ID to the base IP address.
- Parameters:
-
| serialNumber | The serial number of the scanner whose IP address you want to set. |
| baseIpAddress | The base IP address the scanner will use to determine its final IP address. |
| netmask | The IP netmask the scanner will use. |
- Returns:
- 0 on success.
INVALID_PARAMETER if baseIpAddress or netmask is NULL or invalid.
-1 on all other failures.
|
| JCAM_DLL_API int STDCALL jsSetCableId |
( |
UINT32 const |
serialNumber, |
|
|
UINT32 const |
cableId |
|
) |
|
|
|
|
Overrides the cable ID physically wired into a scanner.
The new cable ID is persistent. If the scanner is rebooted, it will ignore the physically wired in cable ID. If the scanner is set to use Base+IP addressing, the scanner's IP address will change according to the new IP address.
- See also:
jsClearCableId()
- Parameters:
-
| serialNumber | The serial number of the scanner to change. |
| cableId | The cable ID you wish the scanner to have. |
- Returns:
- 0 on success.
INVALID_PARAMETER if cableId is over 31.
-1 on all other failures.
|
| JCAM_DLL_API int STDCALL jsClearCableId |
( |
UINT32 const |
serialNumber |
) |
|
|
|
|
Reverts to the cable ID physically wired into a scanner.
If the scanner is set to use Base+IP addressing, the scanner's IP address will change according to the new IP address.
- See also:
jsSetCableId()
- Parameters:
-
| serialNumber | The serial number of the scanner to change. |
- Returns:
- 0 on success.
INVALID_PARAMETER cableId is over 31.
-1 on all other failures.
|
Click here to leave feedback
