EXPORT Commands¶
:EXPort:DIRectory¶
Syntax |
:EXPort:DIRectory? |
---|---|
Description |
Queries the current export folder |
Parameter |
None |
Explanation |
Returns the current directory of the OXYGEN export files. If the current folder is empty, the OXYGEN export default directory is used. |
Return Format |
String |
Example |
-> :EXP:DIR? <- :EXP:DIR "d:/temp" |
:EXPort:DIRectory “path”¶
Syntax |
:EXPort:DIRectory “path” |
||||||||
---|---|---|---|---|---|---|---|---|---|
Description |
Sets the current export folder |
||||||||
Parameter |
|
||||||||
Explanation |
Sets the OXYGEN export folder. An error code is set if the input parameter is wrong or ill formed. |
||||||||
Example |
-> :EXP:DIR "c:/temp" -> :EXP:DIR? <- :EXP:DIR "c:/temp" |
:EXPort:AUTO?¶
Syntax |
:EXPort:AUTO? |
---|---|
Description |
Queries the auto export flag |
Parameter |
None |
Explanation |
Returns the current OXYGEN export flag. |
Return Format |
<Boolean> |
Example |
-> :EXP:AUTO? <- :EXP:AUTO ON |
:EXPort:AUTO {ON|OFF}¶
Syntax |
:EXPort:AUTO {ON|OFF} |
||||||||
---|---|---|---|---|---|---|---|---|---|
Description |
Sets the OXYGEN auto export flag. |
||||||||
Parameter |
|
||||||||
Explanation |
Enables/disables the OXYGEN auto export. When enabled OXYGEN exports selected data to the export folder, after the recording stop event (see :STORe:STOP command above). An error code is set if input parameter is wrong or ill formed- |
||||||||
Example |
-> :EXP:AUTO ON -> :EXP:AUTO? <- :EXP:AUTO ON |
:EXPort:ITEMS Commands and Queries¶
:EXPort:ITEMS[:LIST]?¶
Syntax |
:EXPort:ITEMS[:LIST]? |
---|---|
Description |
Queries the selected channels for export |
Parameter |
None |
Explanation |
Returns a list of elements alternating the channel id and the channel name. Note: this is the default query in the export items subsystem (see examples) |
Return Format |
(<String>, <String>)[,(<String>, <String>)[,…]] | NONE |
Example |
-> :EXPort:ITEMS:LIST? <- ("12942219420566028311","AI 1/1 Sim"),("12942219420566028312","AI 1/2 Sim") ... -> :EXPort:ITEMS? //use as default query <- ("12942219420566028311","AI 1/1 Sim"),("12942219420566028312","AI 1/2 Sim") |
:EXPort:ITEMS[:LIST] <channel>[,<channel>[,…]]¶
Syntax |
:EXPort:ITEMS[:LIST] <channel>[,<channel>[,…]] |
||||||||
---|---|---|---|---|---|---|---|---|---|
Description |
Setup the export selected channels list |
||||||||
Parameter |
|
||||||||
Explanation |
The user can specify a list of multiple channels to set as selected export channels. If one channel does not exist, is invalid or disabled, no channel is set for the export (see system error log for more details). |
||||||||
Example |
Set two channels for export selection list: AI 1/1 and AI 1/2 -> :EXPort:ITEMS:LIST "AI 1/1 Sim","14597010808647974936" -> :EXPort:ITEMS:LIST? <- ("14597010808647974935","AI 1/1 Sim"),("14597010808647974936","AI 1/2 Sim") ... -> :EXPort:ITEMS "AI 1/3 Sim","AI 1/4 Sim" //use as default query -> :EXPort:ITEMS? <- ("14597010808647974937","AI 1/3 Sim"),("14597010808647974938","AI 1/4 Sim") |
:EXPort:ITEMS:AVAil?¶
Syntax |
:EXPort:ITEMS:AVAil? |
---|---|
Description |
Queries all channels which are available for export |
Parameter |
None |
Explanation |
Returns a list of elements alternating the channel id and the channel name |
Return Format |
(<String>, <String>)[,(<String>, <String>)[,…]] | NONE |
Example |
-> :EXPort:ITEMS:AVAil? <- ("14597010808647974935","AI 1/1 Sim"),("14597010808647974936","AI 1/2 Sim"),("14597010808647974937","AI 1/3 Sim")... |
:EXPort:ITEMS:CLEar¶
Syntax |
:EXPort:ITEMS:CLEar |
---|---|
Description |
Clear export channels list |
Parameter |
None |
Explanation |
Remove all selected export channels from the export channels list |
Example |
-> :EXPort:ITEMS? <- ("14597010808647974937","AI 1/3 Sim"),("14597010808647974938","AI 1/4 Sim") -> :EXPort:ITEMS:CLEar -> :EXPort:ITEMS? <- NONE |
:EXPort:ITEMS:ADD <channel>[,<channel>[,…]]¶
Syntax |
:EXPort:ITEMS:ADD <channel>[,<channel>[,…]] |
||||||||
---|---|---|---|---|---|---|---|---|---|
Description |
Adds one or more channels to the export channels list |
||||||||
Parameter |
|
||||||||
Explanation |
The user can specify a list of multiple channels to add these to the selected export channels. If one channel does not exist, is invalid or disabled, no channel is added to the export channels list (see system error log for more details). |
||||||||
Example |
Add channel “AI 1/1 Sim” to the export selection list -> :EXPort:ITEMS:LIST? <- ("8709117245814472727","AI 1/1 Sim") -> :EXPort:ITEMS:ADD "AI 1/2 Sim" -> :EXPort:ITEMS? <- ("8709117245814472727","AI 1/1 Sim"),("8709117245814472728","AI 1/2 Sim") |
:EXPort:ITEMS:DELete <channel>[,<channel>[,…]]¶
Syntax |
:EXPort:ITEMS:DELete <channel>[,<channel>[,…]] |
||||||||
---|---|---|---|---|---|---|---|---|---|
Description |
Deletes one or more channels from the export channels list |
||||||||
Parameter |
|
||||||||
Explanation |
The user can specify a list of multiple channels to remove these from the selected export channels. If one channel does not exist, is invalid or disabled, no channel is removed from the channels export list (see system error log for more details). |
||||||||
Example |
Remove channel “AI 1/1 Sim” from the export selection list -> :EXPort:ITEMS:LIST? <- (("8709117245814472727","AI 1/1 Sim"),("8709117245814472728","AI 1/2 Sim") -> :EXPort:ITEMS:DELete "AI 1/1 Sim" -> :EXPort:ITEMS? <- ("8709117245814472728","AI 1/2 Sim") |