RS485 API for PiezoDrive PDUS210

Version 300000 firmware or higher

All commands except for getSTATE and getSTATEWAVE and returns will use \r as a termination key.
getSTATE will return a buffer that is 80 bytes.
getSTATEWAVE will return a buffer that is 2080 bytes.
Baud rates of 9600, 115200, 460800, 921600 are selectable through the desktop software, with the default being 9600. It is recommended that 921600 is used if using the getSTATEWAVE command.
Allow 2.5 ms between commands

Operational Commands

Enable

Enables the amplifier output.


Command	`ENABLE\r`
Notes	Will return the new value. Clears overload errors.

Example

send: ENABLE\r

read: TRUE\r

Disable

Disable the amplifier output.


Command	`DISABLE\r`
Notes	Will return the new value.

Example

send: DISABLE\r

read: FALSE\r

Enable Phase Tracking

Enables phase tracking.


Command	`enPHASE\r`
Notes	New value is returned.

Example

send: enPHASE\r

read: TRUE\r

Disable Phase Tracking

Disables phase tracking.


Command	`disPHASE\r`
Notes	New value is returned.

Example

send: disPHASE\r

read: FALSE\r

Enable Power Tracking

Enable power tracking.


Command	`enPOWER\r`
Notes	New value is returned. Disables current tracking.

Example

send: enPOWER\r

read: TRUE\r

Disable Power Tracking

Disable power tracking.


Command	`disPOWER\r`
Notes	New value is returned.

Example

send: disPOWER\r

read: FALSE\r

Enable Current Tracking

Enable current tracking.


Command	`enCURRENT\r`
Notes	New value is returned. Disables power tracking.

Example

send: enCURRENT\r

read: TRUE\r

Disable Power Tracking

Disable current tracking.


Command	`disCURRENT\r`
Notes	New value is returned.

Example

send: disCURRENT\r

read: FALSE\r

Disable Frequency Wrapping

Disables frequency wrapping when phase tracking is enabled.


Command	`disWRAP\r`
Notes	New value is returned.

Example

send: disWRAP\r

read: FALSE\r

Enable Frequency Wrapping

Enables frequency wrapping when phase tracking is enabled.


Command	`enWRAP\r`
Notes	New value is returned.

Example

send: enWRAP\r

read: ENABLE\r

Save Parameters

Save current parameters to permanent storage.

Save Parameters

Save current parameters to permanent storage.

Example

send: SAVE\r

read: TRUE\r

Operational Queries

Is Enabled

Queries if the amplifier is enabled.


Command	`isENABLE\r`
Returns	`TRUE\r` or `FALSE\r`

Example

send: isENABLE\r

receive: TRUE\r

Is Phase Tracking

Queries if phase tracking is enabled.


Command	`isPHASE\r`
Returns	`TRUE\r` or `FALSE\r`

Example

send: isPHASE\r

receive: TRUE\r

Is Power Tracking

Queries if power tracking is enabled.


Command	`isPOWER\r`
Returns	`TRUE\r` or `FALSE\r`

Example

send: isPOWER\r

receive: TRUE\r

Is Current Tracking

Queries if current tracking is enabled.


Command	`isCURRENT\r`
Returns	`TRUE\r` or `FALSE\r`

Example

send: isCURRENT\r

receive: TRUE\r

Is Frequency Wrapping

Queries if frequency wrapping is enabled.


Command	`isWRAP\r`
Returns	`TRUE\r` or `FALSE\r`

Example

send: isWRAP\r

receive: TRUE\r

Set Control Parameters

Set Output Voltage

Sets the amplifier output voltage.


Command	`setVOLT[voltage]\r`
Required	Voltage=[integer], peak to peak voltage in volts
Notes	New value is returned. Clipped between 0 and the maximum voltage output. Note Output voltage can't be changed while power tracking or current tracking is enabled.

Example

send: setVOLT100\r

read: 100\r

Set Output Frequency

Sets the amplifier output frequency.


Command	`setFREQ[frequency]\r`
Required	Frequency=[integer], frequency in Hz
Notes	New value is returned. Clipped between the minimum and maximum frequency. Will not update if phase tracking is enabled.

Example

send: setFREQ50000\r

read: 50000\r

Set Maximum Output Frequency

Sets the amplifier maximum output frequency.


Command	`setMAXFREQ[frequency]\r`
Required	Frequency=[integer], frequency in Hz
Notes	New value is returned. Clipped between the minimum frequency and 520000 Hz. Will limit the range of the frequency used for phase tracking.

Example

send: setMAXFREQ55000\r

read: 55000\r

Set Minimum Output Frequency

Sets the amplifier minimum output frequency.


Command	`setMINFREQ[frequency]\r`
Required	Frequency=[integer], frequency in Hz
Notes	New value is returned. Clipped between 5400 Hz and the maximum frequency. Will limit the range of the frequency used for phase tracking.

Example

send: setMINFREQ45000\r

read: 45000\r

Set Target Phase

Sets the amplifier target phase.


Command	`setPHASE[phase]\r`
Required	Phase=[integer], phase in degrees
Notes	New value is returned. Clipped between -180 and 180

Example

send: setPHASE-10\r

read: -10\r

Set Maximum Load Power

Sets the maximum power applied to the load.


Command	`setMAXLPOW[power]\r`
Required	Power=[integer], power in mW
Notes	New value is returned. Clipped between 0 and 210000 mW

Example

send: setMAXLPOW100000\r

read: 100000\r

Set Target Power

Sets the target power applied to the load.


Command	`setTARPOW[power]\r`
Required	Power=[integer], power in mW
Notes	New value is returned. Clipped between 0 and maximum load power

Example

send: setTARPOW90000\r

read: 90000\r

Set Target Current

Sets the target current magnitude.


Command	`setCURRENT[current]\r`
Required	Power=[integer], current in mA
Notes	New value is returned. Clipped between 0 and 20000 mA

Example

send: setCURRENT1000\r

read: 1000\r

Set Phase Gain

Sets the control gain used for phase tracking.


Command	`setGAINPHASE[phase gain]\r`
Required	Phase gain=[integer]
Notes	New value is returned. Clipped between -100000 and 100000

Example

send: setGAINPHASE1000\r

read: 1000\r

Set Power Gain

Sets the control gain used for power tracking.


Command	`setGAINPOWER[power gain]\r`
Required	Power gain=[integer]
Notes	New value is returned. Clipped between 0 and 100000

Example

send: setGAINPOWER100\r

read: 100\r

Set Current Gain

Sets the control gain used for current tracking.


Command	`setGAINCURRENT[power gain]\r`
Required	Power gain=[integer]
Notes	New value is returned. Clipped between 0and 100000

Example

send: setGAINCURRENT1000\r

read: 1000\r

Check response.

Get Control Parameters

Get Output Voltage

Returns the amplifier output voltage.


Command	`getVOLT\r`
Returns	peak to peak voltage in V

Example send: getVOLT\r

receive: 100\r

Get Output Frequency

Returns the amplifier output frequency.


Command	`getFREQ\r`
Returns	Frequency in Hz

Example

send: getFREQ\r

receive: 80000\r

Get Maximum Frequency

Returns the amplifier maximum output frequency.


Command	`getMAXFREQ\r`
Returns	Maximum frequency in Hz

Example

send: getMAXFREQ\r

receive: 90000\r

Get Minimum Frequency

Returns the amplifier minimum output frequency.


Command	`getMINFREQ\r`
Returns	Minimum frequency in Hz

Example

send: getMINFREQ\r

receive: 70000\r

Get Target Phase

Returns the target phase.


Command	`getPHASE\r`
Returns	Phase in degrees

Example

send: getPHASE\r

receive: -10\r

Get Maximum Load Power

Returns the maximum load power.


Command	`getMAXLPOW\r`
Returns	Power in mW

Example

send: getMAXLPOW\r

receive: 100000\r

Get Target Load Power

Returns the target load power.


Command	`getTARPOW\r`
Returns	Power in mW

Example

send: getTARPOW\r

receive: 90000\r

Get Phase Gain

Returns the phase tracking control gain.


Command	`getPHASEGAIN\r`
Returns	Gain

Example

send: getPHASEGAIN\r

receive: 1000\r

Get Power Gain

Returns the set power tracking control gain.


Command	`getPOWERGAIN\r`
Returns	Gain

Example

send: getPOWERGAIN\r

receive: 200\r

Get Current

Returns the set current.


Command	`getCURRENT\r`
Returns	Current in mA

Example

send: getCURRENT\r

receive: 1000\r

Read Measured Values

Read Measured Phase

Returns the measured phase.


Command	`readPHASE\r`
Returns	Phase in degrees

Example

send: readPHASE\r

receive: 11\r

Read Measured Impedance

Returns the measured impedance.


Command	`readIMP\r`
Returns	Load impedance in ohms

Example

send: readIMP\r

receive: 220\r

Read Load Power

Returns the measured load power.


Command	`readLPOW\r`
Returns	Power in mW

Example

send: readLPOW\r

receive: 91230\r

Read Amplifier Power

Returns power dissipated via the amplifier.


Command	`readAPOW\r`
Returns	Power in mW

Example

send: readAPOW\r

receive: 111230\r

Read Current

Returns measured current magnitude.


Command	`readCURRENT\r`
Returns	Current in mA

Example

send: readCURRENT\r

receive: 1033\r

Read Amplifier Temperature

Returns the measured amplifier temperature.


Command	`readTEMP\r`
Returns	temperature in celsius

Example

send: readTEMP\r

receive: 42\r

Errors

Communication Error

Error will occur when corrupted commands are sent to the amplifier via RS485. It is suggested to resend the command.


Message	`TXERR\r`

Load Overload Error

Error will occur when load power exceeds the set load power value. Is sent 10 times at 100 ms intervals to insure it is received. Is reset via the Enable command.


Message	`LPERR\r`
Reset	`ENABLE\r`

Example

receive: LPERR\r

wait: 2 s

send: ENABLE\r

Amplifier Overload Error

Error will occur when amplifier dissipation power exceeds set value. Is sent 10 times at 100 ms intervals to insure it is received. Is reset via the Enable command.


Message	`APERR\r`
Reset	`ENABLE\r`

Example

receive: APERR\r

wait: 2 s

send: ENABLE\r

Amplifier Temperature Error

Error will occur when amplifier temperature exceeds set value. Is sent 10 times at 100 ms intervals to insure it is received. Is reset via the Enable command.


Message	`ATERR\r`
Reset	`ENABLE\r`

Example

receive: ATERR\r

wait: 2 s

send: ENABLE\r

Disable Error Reporting

Disables the reporting of the load overload, amplifier overload and temperature overload errors. To used when using the getSTATE command to monitor for errors. Returns TRUE when updated. See examples:

sweep_example.py
state_example.py
gui_example.py


Command	`disERROR\r`

Example

send: disERROR\r

receive: TRUE\r

Get Amplifier state

Get state

Returns the current state of the amplifier as a buffer. See examples:

sweep_example.py
state_example.py


Command	`getSTATE\r`
Returns	Buffer 80 bytes long

structure

In order as shown in table

Type	Name	Units
char	enabled
char	power tracking
char	current tracking
char	powerTracking
char	error amp
char	error load
char	error temperature
char	padding
float	voltage	V peak-peak
float	frequency	Hz
float	min frequency	Hz
float	max frequency	Hz
float	target phase	Deg
float	phase control gain
float	target current	mA
float	current control gain
float	target power	W
float	power control gain
float	max load power	W
float	amplifier power	W
float	load power	W
float	temperature	C
float	measured phase	Deg
float	measured current	mA peak
float	impedance	Ohms
float	transformer turns

Get state with waveform

Returns the current state of the amplifier and voltage and current waveforms as a buffer. See examples:

gui_example.py


Command	`getSTATEWAVE\r`
Returns	Buffer 2080 bytes long

structure

In order as shown in table

Type	Name	Units
char	enabled
char	power tracking
char	current tracking
char	powerTracking
char	error amp
char	error load
char	error temperature
char	padding
float	voltage	V peak-peak
float	frequency	Hz
float	min frequency	Hz
float	max frequency	Hz
float	target phase	Deg
float	phase control gain
float	target current	mA
float	current control gain
float	target power	W
float	power control gain
float	max load power	W
float	amplifier power	W
float	load power	W
float	temperature	C
float	measured phase	Deg
float	measured current	mA peak
float	impedance	Ohms
float	transformer turns
float[250]	voltage waveform	V
float[250]	current waveform	A

Get state with waveform raw

Returns the current state of the amplifier and the raw voltage and current waveforms as a buffer. The waveform buffer consists of interleaved current and voltage values, which will need to be scaled. See examples:

gui_example_raw_wave.py
raw_wave_example.py


Command	`getSTATERAW\r`
Returns	Buffer 8080 bytes long

structure

In order as shown in table

Type	Name	Units
char	enabled
char	power tracking
char	current tracking
char	powerTracking
char	error amp
char	error load
char	error temperature
char	padding
float	voltage	V peak-peak
float	frequency	Hz
float	min frequency	Hz
float	max frequency	Hz
float	target phase	Deg
float	phase control gain
float	target current	mA
float	current control gain
float	target power	W
float	power control gain
float	max load power	W
float	amplifier power	W
float	load power	W
float	temperature	C
float	measured phase	Deg
float	measured current	mA peak
float	impedance	Ohms
float	transformer turns
unsigned short[2000]	Waveform Buffer	12 bit value (4096 max)

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
.vscode		.vscode
README.md		README.md
fbs.gitignore		fbs.gitignore
gui_example.py		gui_example.py
gui_example_raw_wave.py		gui_example_raw_wave.py
raw_wave_example.py		raw_wave_example.py
single_command_example.py		single_command_example.py
speed_test.py		speed_test.py
state_example.py		state_example.py
sweep_example.py		sweep_example.py
sweep_with_verify_example.py		sweep_with_verify_example.py

junjun8959/RS485-API

Folders and files

Latest commit

History

Repository files navigation

RS485 API for PiezoDrive PDUS210

Version 300000 firmware or higher

Operational Commands

Enable

Disable

Enable Phase Tracking

Disable Phase Tracking

Enable Power Tracking

Disable Power Tracking

Enable Current Tracking

Disable Power Tracking

Disable Frequency Wrapping

Enable Frequency Wrapping

Save Parameters

Save Parameters

Operational Queries

Is Enabled

Is Phase Tracking

Is Power Tracking

Is Current Tracking

Is Frequency Wrapping

Set Control Parameters

Set Output Voltage

Set Output Frequency

Set Maximum Output Frequency

Set Minimum Output Frequency

Set Target Phase

Set Maximum Load Power

Set Target Power

Set Target Current

Set Phase Gain

Set Power Gain

Set Current Gain

Get Control Parameters

Get Output Voltage

Get Output Frequency

Get Maximum Frequency

Get Minimum Frequency

Get Target Phase

Get Maximum Load Power

Get Target Load Power

Get Phase Gain

Get Power Gain

Get Current

Read Measured Values

Read Measured Phase

Read Measured Impedance

Read Load Power

Read Amplifier Power

Read Current

Read Amplifier Temperature

Errors

Communication Error

Load Overload Error

Amplifier Overload Error

Amplifier Temperature Error

Disable Error Reporting

Get Amplifier state

Get state

structure

Get state with waveform

structure

Get state with waveform raw

structure

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages