SSH Server Manual - Pickering Downloads · 2013. 12. 18. · The SSH server is now operative and...

Page 1

COMMAND LINE CONTROL OF LXI INSTRUMENTS

pickering

Issue B December 2013

User Manual

Command Line Control ofPickering LXI Instruments

pickeringtest.com pickering

PRELIMINARY

Page ii


pickering

© COPYRIGHT (2013) PICKERING INTERFACES. ALL RIGHTS RESERVED.

No part of this publication may be reproduced, transmitted, transcribed, translated or stored in any form, or by any means without the written permission of Pickering Interfaces.

Technical details contained within this publication are subject to change without notice.

ISO 9001Reg No. FM38792

Page iii


pickering

TECHNICAL SUPPORT

For Technical Support please contact Pickering Interfaces either by phone, fax, the website or via e-mail.

WARRANTY

All products manufactured by Pickering Interfaces are warranted against defective materials and workmanship for a period of three years, excluding programmable power supplies, from the date of delivery to the original purchaser. Any product found to be defective within this period will, at the discretion of Pickering Interfaces be repaired or replaced.

Warranty is on a return to factory basis, however, for most systems, the module may be replaced on a module exchange basis. A module will be delivered to the user and the faulty part returned to Pickering Interfaces on receipt.

Products serviced and repaired outside of the warranty period are warranted for ninety days.

Extended warranty and service are available. Please contact Pickering Interfaces by phone, fax, the website or via e-mail.

ENVIRONMENTAL POLICY

Pickering Interfaces operates under an environmental management system similar to ISO 14001.

Pickering Interfaces strives to fulfil all relevant environmental laws and regulations and reduce wastes and releases to the environment. Pickering Interfaces aims to design and operate products in a way that protects the environment and the health and safety of its employees, customers and the public. Pickering Interfaces endeavours to develop and manufacture products that can be produced, distributed, used and recycled, or disposed of, in a safe and

environmentally friendly manner.

Worldwide Technical Support and Product Informationhttp://www.pickeringtest.com

Pickering Interfaces HeadquartersStephenson Road Clacton-on-Sea CO15 4NL United KingdomTel: +44 (0)1255-687900Fax: +44 (0)1255-475058E-Mail: [email protected]

Pickering Interfaces GmbHJohann-Karg-Straße 30D-85540Haar-SalmdorfGermany

Tel: +49 89 125 953 160Fax: +49 89 125 953 189E-Mail: [email protected]

Pickering Interfaces ABKarl Nordströmsväg 31432 53 VarbergSweden

Tel: +46 340-69 06 69Fax: +46 340-69 06 68E-Mail: [email protected]

Pickering Interfaces Inc.2900 Northwest Vine StreetGrants PassOregon 97526USA

Tel: +1 541 471 0700Fax: +1 541 471 8828E-Mail: [email protected]

Pickering Interfaces Inc. (East Coast Regional Office) 67 South Bedford Street, Suite 400W Burlington, Massachusetts 01803 USA Tel: +1 781 229 5882 Fax: +1 781 272 0558 E-mail: [email protected]

Pickering Interfaces s.r.o.Smetanova 525Trinec739 61Czech Republic

Tel: +420 558 339 168Fax: +420 558 340 888E-mail: [email protected]

ˇ

Pickering Interfaces SARL6 Rue De La Mare Blanche77186 NoisielMarne Le ValleeFrance

Tel +33 1 60 53 55 50Fax +33 1 60 53 55 99email [email protected]

Page iv


pickering

THIS PAGE INTENTIONALLY BLANK

Page v


pickering

Section 1Command Line Control of Pickering LXI Instruments .... 1.1 Overview........................................................................1.1 Enabling The Command Line Utility ........................... 1.1 Step 1 - Enable Security............................................... 1.1 Step 2 - Enable The SSH Server .................................. 1.2 Notes..............................................................................1.3 Instrument Control From an SSH Client ..................... 1.4 Using Expect with SSH on an LXI Device .................. 1.7

Appendix AOriginal Version PILMon Command Set ...........................A.1 Example Commands ....................................................A.2

Appendix BNew Version PILMon Extended Command Set ................B.1 Example Commands ....................................................B.7

CONTENTS

Page vi


pickering


SECTION 1

Page 1.1COMMAND LINE CONTROL OF LXI INSTRUMENTS

pickering

COMMAND LINE CONTROL OF PICKERING LXI INSTRUMENTS

OverviewCommand line control of the Pickering LXI device range was added in firmware release 2.11. The utility provided was ported to the LXI instrument from the Windows utility PILMon and provides identical functionality.

Enabling the Command Line Control UtilityPickering LXI devices do not provide an SSH server in the normal configuration state, the service must be explicitly enabled.

To do this the user must first enable security, this helps to prevent inadvertent access by limiting the accessibility of instrument services, principally by requiring password access to control functions. Once security is enabled, the SSH server may be started.

All the following assumes that the user knows the IP address of the LXI device. If this is not known, a number of tools are available, many on the Pickering distribution disk, to allow the IP address to be discovered.

Step 1 - Enable SecuritySelect the Security Page from the main menu list

Page 1.2

SECTION 1


pickering

Step 2 - Enable the SSH serverSelect the Instruments Control page from the main menu and find the SSH Server Control Section.

Enter a password and confirm then click on the Submit button. The page should change to show that security is enabled

SECTION 1


pickering

Click on Start SSH server, the page should change to show the service running.

The SSH server is now operative and instrument control access is available from an external SSH client application.

NOTES:The password and state of the SSH server are stored in non-volatile memory within the LXI device and so will remain in effect even after a power cycle. It is important to remember the password applied. Should the password be forgotten, the device may be reset to initial conditions by operating the LAN Reset button located at the rear of the device in the appropriate manner. Refer to Section 6 “Troubleshooting” of the user manual for your LXI device for details of this process.

Disabling security will stop the SSH service.

Page 1.4

SECTION 1


pickering

Instrument Control from an SSH ClientIn the following examples the SSH client PuTTY is used, the user will have to adapt the instructions for any other client.

First start up the SSH client and enter the IP address of the LXI device. Press Open for launch.

SECTION 1


pickering

The user will be prompted for a login name and password.

The username for instrument control is ‘sshuser’, the password is that defined by the user when setting security.

Once the username and password have been supplied, the LXI device will enter an application providing a command line interface to the switch cards within the device.

Page 1.6

SECTION 1


pickering

When the application is expecting input, the prompt pilmon> will be displayed. Card control is achieved using a set of mnemonics plus optional data. These mnemonics are based on the Direct IO driver pilpxi.dll.

Brief details of operation is given here, full documentation instruction set may be obtained by referring to the documentation for the pilpxi or pipx40 drivers and is available in a separate document.

By default, the application opens all available switch cards contained in the LXI device. This access is exclusive and prevents other users from accessing the cards thus preventing inadvertent operation switching functions from another location.

Typing HE in response to the prompt will list the entire command set avalailable.

The command set for the original version of PILMon is listed in Appendix A and the extended commannd set for the new version of PILMon is listed in Appendix B at the end of this document.

For any specific operation the appropriate command must be chosen, a few of the more commonly used commands are listed at the end of the appendices:

Before attempting to control a card it is important to understand the switch architecture of that card and to know how to address the required switch. Each Pickering switch card is represented as a set of one or more sub-units, each sub-unit containing one or more switches. A sub-unit represents a collection of switches of similar type, it may represent an entire matrix, or a row of simple switches, or a power supply voltage setting.

In the case of a switch sub-unit, each switch is represented by a single bit of data and may be toggled between 0 and 1, 0 representing the off state of the switch relay and 1 representing the on state.

The precise relationship between bit positions and switch location is provided in the card manual, or by use of the LS command inside the utility program PILMon in Windows, or by the LXI SSH service application.

SECTION 1


pickering

Using Expect with SSH on an LXI DeviceSecure Shell (SSH) is typically used to allow users to remotely login to an account using an interactive command line terminal, Pickering LXI devices offer an SSH service. This is normally of little use as programming interface, however software products exist which allow the user to convert such an interactive interface into a programming interface, one such product is Expect. Expect allows the user to create a program, written in Tcl, the native language of Expect, to handle interactive command line interfaces.

Expect may be obtained from: http://expect.nist.gov/

Here is a simple Expect script which gains access to a Pickering LXI device, clears the first subunit, then sets some switches and obtains the current switch settings. The LXI device was set up with SSH enabled, and a password of “lxi”.

#!/usr/bin/expect -f # Start SSH session on device at 192.168.50.130 with username ‘sshuser’spawn ssh [email protected] # wait until the text ‘password:’ is returned from the session, then reply with the password ‘lxi’expect “password:”send “lxi\r” # wait until the prompt ‘LXI>’ is returnedexpect “LXI>” # clear the default subunit on the LXI devicesend “cs\r”expect “LXI>” # set bit 1send “sc 1\r”expect “LXI>” # obtain settings of all switches on current subunitsend “bv\r”expect “LXI>” # now set bit 5send “sc 5\r”expect “LXI>”send “bv\r”expect “LXI>” # quit remote SSH sessionsend “q\r”puts “All done”

The output of the above script is shown on the following page.

http://expect.nist.gov

Page 1.8

SECTION 1


pickering

debian:~# ./testsshspawn ssh [email protected]@192.168.50.130’s password: Monitor Program for Pickering Interfaces PXI Cards==================================================Version 1.55(c) Pickering Interfaces Ltd. 20 Sep 2007 PILPXI Driver version number = 286Number of Pickering cards opened = 1Selected card 1, sub-unit 1: Input = none, Output = SWITCH(10)Enter ‘HE’ for help. LXI> OK, we’re incsOKLXI> sc 1OKLXI> bv001LXI> sc 5OKLXI> bv011LXI> All donedebian:~#

NOTE: The example above uses a Pickering switch card with a 10 bit wide subunit representing a group of 10 switches, the returned results are in hexadecimal format with the least significant bit representing bit 1 of the switch group.

APPENDIX A

Page A.1

pickering


APPENDIX A - Original Version PILMon

Original Version PILMon Command Set

Command DescriptionAD [<card> <sub_unit>] [select and] display card/sub-unit to addressSC <number> close output (set ON)SO <number> open output (set OFF)SB <bit_pattern> set sub-unit outputs (to hex bit-pattern)CS clear OUTPUT sub-unitRS clear all OUTPUT sub-units on all open cardsST display status of currently-selected cardBV view sub-unit output states (as hex bit-pattern)BR read INPUT sub-unit (as hex bit-pattern)LS [<card>] list info on all open cards, or specified cardEC <0/1> turn serial echo OFF/ON (default = ON)WC <number> <value> write the calibration value for an outputRC <number> read the calibration value for an outputLC list calibration valuesDM <bit_pattern> set driver mode flags (to hex bit-pattern)AC <number> matrix: close all points on single row or columnCM clear OUTPUT sub-unit maskSM <number> <0/1> UNMASK/MASK an individual outputMB <bit_pattern> set OUTPUT sub-unit mask (to hex bit-pattern)MV view sub-unit output mask (as hex bit-pattern)OC take control of all Pickering switch cardsCC release control of all Pickering switch cardsVO <bus> <slot> open card at specified locationVC <card> close specified cardHE/HL show this help informationSV <number> show state of specified outputMS <number> show mask state of specified outputIS <number> show state of specified inputAR clear all OUTPUT sub-units of the current cardXC <row> <column> close matrix crosspointXO <row> <column> open matrix crosspointXV <row> <column> show state of a matrix crosspointXM <row> <column> <0/1> UNMASK/MASK a matrix crosspointXS <row> <column> show matrix crosspoint mask stateDI show diagnostic informationSE show sub-unit settling time (µs)CL show sub-unit closure limitSS show sub-unit statusPT show PSU type descriptionPI show PSU informationPS <fp value> set PSU output voltagePV show PSU output voltage settingPE <0/1> DISABLE/ENABLE the output of a PSUCF show number of free cardsLF list bus/slot locations of free cardsQ quit the program

Page A.2

APPENDIX A pickering


Example Commands - Original Version of PILMon

AD 1 2 Selects card 1, sub-unit 2

SC 3 Closes switch 3 on current sub-unit

AD 1 3 Selects card 1, sub-unit 3

BV 5 Obtains state of switch 5 on current sub-unit

APPENDIX B

Page B.1

pickering


APPENDIX B- New Version PILMon

New Version PILMon Extended Command SetCommands are accepted in long and short form. Commands are not case sensitive. For more detailed description of commands, use: Help <command>

CommandsFunction Description

Long Short

Not Supported AD Select active card and subunit

<card(int)> <subunit(int)> [input(int)] Selects active <subunit> on card number <card>. Optional parameter <input> states whether to get information about input-0 or output-1 subunit. Implicitly it’s output.

Not Supported SC Close switch <bit(int)> Close switch (energize relay coil) on selected subunit of index <bit>.

Not Supported SO Open switch <bit(int)> Open switch (disengage relay coil) on selected subunit of index <bit>.

Not Supported SBWrite states of switches on subunit

<pattern(hex string)> Writes hex string converted to bit array into subunit. Note that hex string must be started with \0x\”notation”

Not Supported CS Clear subunit <no parameters> Clear all switches (disengage relays) on selected subunit.

Not Supported RS Clear all cards <no parameters> Clear all switches on all subunits on all cards.

Not Supported ST Get card status code

<no parameters> Get status of selected card. Status consists of binary flags detecting various problems of card. Result: hex integer containing status flags.

Not Supported BVView states of switches on subunit

<no parameters> View states of all switches on selected subunit. Return hex string describing states of switches. Each bit in hex string represents 1 switch.

Not Supported BRRead state of whole input subunit

<no parameters> Read states of all bits of selected input subunit. Returns hex string representing all states of bits.

Not Supported LS List all cards List all cards and show their location. For opened cards more details will be displayed.

Not Supported WC Write int calibration value

<index(int)> <value(int)> Write integer calibration value <value> of pad <index>.

Not Supported RC Read int calibration value

<index(int)> Read integer calibration value of pad <index>. Returns integer value.

Not Supported DM Set mode of driver

Set driver in different working mode. This feature is to be used only by experts!

Not Supported AC

Not Supported CM Clear mask on whole subunit <no parameters> Clears all mask bits on selected subunit.

Not Supported SM

Not Supported MBWrite mask states to whole subunit

<pattern(hex string)> Writes hex string converted to bit array into subunit mask bits. Note that hex string must be started with \0x\”notation”.

Not Supported MVView state of mask on whole subunit

<no parameters> View states of all mask bits on selected subunit. Return hex string describing mask. Each bit in hex string represents 1 bit of mask.

Page B.2

APPENDIX B pickering



Long Short

Not Supported OC Open all cards in LXI

[access(int)] Open all cards in LXI if possible. Optional parameter [access] modifies access setting. 1-exclusive access 0-nonexclusive access. Cards are opened with exclusive access implicitly.

Not Supported CC Close all cards <no parameters> Close all opened cards.

Not Supported VOOpen card with specified bus and slot

<bus(int)> <device(int)> [access(int)] Open card on physical position <bus> <device>. Optional parameter [access] modifies access setting. 1-exclusive access 0-nonexclusive access. Card is opened with exclusive access implicitly.

Not Supported VC Close current card

<no parameters> Close selected card. Card can't be used until opened again.

Help HE Show this helpShow help about all commands. Help <command> shows more detailed explanation of syntax and meaning of commands.

Help HL Show this helpShow help about all commands. Help <command> shows more detailed explanation of syntax and meaning of commands.

Not Supported SV Get state of a switch

<bit(int)> Get state of switch on selected subunit of index <bit>. Returns 1 if coil is energized 0 otherwise.

Not Supported MS Get state of mask of a switch

<bit(int)> Get state of mask of switch on selected subunit of index <bit>. Returns 1 if mask is active 0 otherwise.

Not Supported IS Read bit state of input subunit

<bit(int)> Read state of individual <bit> of selected input subunit. Returns state of bit= 1-active 0-inactive.

Not Supported AR Clear current card

<no parameters> Clear all switches on all subunits on selected card.

Not Supported XC Close crosspoint <column(int)> <row(int)> Close switch (energize relay coil) on selected matrix subunit on position <column> <row>.

Not Supported XO Open crosspoint<column(int)> <row(int)> Open switch (disengage relay coil) on selected matrix subunit on position <column> <row>.

Not Supported XV View state of a crosspoint

<column(int)> <row(int)> Get state of switch on selected matrix subunit on position <column> <row>. Returns 1 if coil is energized 0 otherwise.

Not Supported XM

Not Supported XSGet state of mask of a crosspoint

<column(int)> <row(int)> Get state of mask of switch on selected matrix subunit on position <column> <row>. Returns 1 if mask is active 0 otherwise.

Not Supported DI Get card diagnostic

<no parameters> Get text diagnostic of selected card. When card is faulty diagnostics shows details about faults. Returns diagnostic text.

Not Supported SE Get settling time of relays

<no parameters> Get time in ms that is required for relay contanct to settle down after switch operation. Returns integer value.

Not Supported CL Get closure limit of subunit

<no parameters> Get closure limit of selected subunit.Closure limit is maximum number of switches that can be simultaneously closed on a subunit. Returns integer value.

APPENDIX B

Page B.3

pickering



Long Short

Not Supported SS Status code of subunit

<no parameters> Get status of selected subunit. Status consists of binary flags detecting various problems of subunit. Result: hex integer containing status flags.

Not Supported PT Info about PSU in string form

<no parameters> Get info about selected PSU subunit in string form. Returns info in form: PSUDC(<rated voltage><rated current>).

Not Supported PI Info about PSU<no parameters> Get info about selected PSU subunit. Returns info in form: <type>;<rated voltage>; <rated current>;<precision>;<capabilities(hex flags)>”

Not Supported PS Set voltage of PSU

<voltage(float)> Set voltage setting of selected PSU subunit.

Not Supported PV Get current voltage of PSU

<no parameters> Get current setting of voltage of selected PSU subunit. Returns float value.

Not Supported PE Set enable state of PSU <state(int)> Set output state of PSU subunit.

Not Supported CF Count free cards <no parameters> Get number of available cards in LXI. Returns integer value.

Not Supported LF Find free cards<no parameters> Get location of all unopened cards. Returns locations of cards in form: <bus1> <device1>;<bus2> <device2>;...

Quit Q Quit pilmon Ends work with pilmon. All resources will be freed but states of cards remain unchanged.

AttenuatorAttenuationGet AAG Get current attenuation

<no parameters> Get current attenuation of selected subunit. Returns float value.

AttenuatorAttenuationSet AAS Set current attenuation

<attenuation(float)> Set attenuation of selected subunit to <attenuation>.

AttenuatorInfo AIInfo about attenuator subunit

<no parameters> Get information about selected attenuator subunit. Returns values: <type>;<number of steps>;<size of each step>

AttenuatorPadValue AP Get attenuator pad value

<index(int)> Get value of attenuator pad at <index>. Returns float value.

AttenuatorType ATInfo about attenuator in string form

<no parameters> Get information about selected attenuator subunit in text form. Returns string in form: ATTEN(<number of steps><step size in dB>)

BatteryCurrentGet BCG Get battery simulator current

<no parameters> Get current setting of battery simulator subunit current leak. Returns float value.

BatteryCurrentSet BCS Set battery simulator current <current(float)> Set battery simulator subunit current leak.

BatteryEnableGet BEGGet battery simulator enabled pattern

<no parameters> Get current setting of battery simulator subunit output states. Returns binary pattern characterizing states.

BatteryEnableSet BESSet battery simulator enabled pattern

<pattern(int)> Set battery simulator subunit output states according to pattern.

BatteryInterlockGet BIGGet battery simulator interlock state

<no parameters> Get interlock state of battery simulator subunit. Returns 1 if all interlocks are up or 0 if one or more interlocks are down.

Page B.4




Long Short

BatteryVoltageGet BVG Get battery simulator voltage

<no parameters> Get current setting of battery simulator subunit voltage. Returns float value.

BatteryVoltageSet BVS Set battery simulator voltage <voltage(float)> Set battery simulator subunit votage.

CalibrationReadInt LRI Read int calibration value

<index(int)> Read integer calibration value of pad <index>. Returns integer value.

CalibrationReadDate LRD Read calibration date

<store(int)> Read calibration date of subunit. <store> can be 0-for user store 1-for factory store. Returns date in form: <year>;<day>;<interval>.

CalibrationReadFp LRF Read float calibration value

<store(int)> <offset(int)> Read float calibration value of <store> on position <offset>. Returns float value.

CalibrationWriteInt LWI Write int calibration value

<index(int)> <value(int)> Write integer calibration value <value> of pad <index>.

CalibrationWriteDate LWD Write calibration date

<store(int)> <interval(int)> Write calibration date of subunit. <store> can be 0-for user store 1-for factory store. Date written is current system date <interval> is number of days for cards to be recalibrated.

CalibrationWriteFp LWF Write float calibration value

<store(int)> <offset(int)> <value(float)> Write float calibration value <value> of <store> on position <offset>.

CardClear CC Clear current card

<no parameters> Clear all switches on all subunits on selected card.

CardClearAll CCA Clear all cards <no parameters> Clear all switches on all subunits on all cards.

CardClose CL Close current card

<no parameters> Close selected card. Card cannot be used until opened again.

CardCloseAll CLA Close all cards <no parameters> Close all opened cards.

CardDiagnostic CD Get card diag-nostic

<no parameters> Get text diagnostic of selected card. When card is faulty diagnostics shows details about faults. Returns diagnostic text. It does not diagnose the relays, only communication.

CardId CI Get card id string <no parameters> Get card id string in form: <card model>;<serial number>;<card revision>

CardLoc CLO Get card location <no parameters> Get card physical location. Returns location in form: <bus>;<device>;

CardOpen COOpen card with specified bus and slot

<bus(int)> <device(int)> [access(int)] Open card on physical position <bus> <device>. Optional parameter [access] modifies access setting. 1-exclusive access 0-nonexclusive access. Card is opened with exclusive access implicitly.

CardOpenAll COA Open all cards in LXI

[access(int)] Open all cards in LXI if possible. Optional parameter [access] modifies access setting. 1-exclusive access 0-nonexclusive access. Cards are opened with exclusive access implicitly.

CardStatus CS Get card status code

<no parameters> Get status of selected card. Status consists of binary flags detecting various problems of card. Result: hex integer containing status flags.

FindCountCards FCC Count free cards <no parameters> Get number of available cards in LXI. Returns integer value.

APPENDIX B

Page B.5

pickering



Long Short

FindFreeCards FFC Find free cards<no parameters> Get location of all unopened cards. Returns locations of cards in form: <bus1> <device1>;<bus2> <device2>;...

InputBitRead IBR Read bit state of input subunit

<bit(int)> Read state of individual <bit> of selected input subunit. Returns state of bit= 1-active 0-inactive.

InputSubunitRead IURRead state of whole input subunit

<no parameters> Read states of all bits of selected input subunit. Returns hex string representing all states of bits.

PSUEnableSet PES Set enable state of PSU <state(int)> Set output state of PSU subunit.

PSUInfo PI Info about PSU<no parameters> Get info about selected PSU subunit. Returns info in form: <type>;<rated voltage>; <rated current>;<precision>;<capabilities(hex flags)>

PSUType PT Info about PSU in string form

<no parameters> Get info about selected PSU subunit in string form. Returns info in form: PSUDC(<rated voltage><rated current>).

PSUVoltageGet PVG Get current volt-age of PSU

<no parameters> Get current setting of voltage of selected PSU subunit. Returns float value.

PSUVoltageSet PVS Set voltage of PSU

<voltage(float)> Set voltage setting of selected PSU subunit.

ResistorInfo RI Info about resistor subunit

<no parameters> Get info about selected programmable precision resistor subunit. Returns: <minres>;<maxres>; <referenceres>;<precisionpc>;<precisiondelta>; <reserved>;<reserved>;<capabilities(hex flags)>

ResistorResistanceGet RRGGet current resistance of subunit

<no parameters> Get output resistance of selected programmable precision resistor subunit. Returns float value.

ResistorResistanceSet RRS Set resistance of subunit

<resistance(float)> Set output resistance of selected programmable precision resistor subunit to <resistance>.

SwitchClose SC Close switch <bit(int)> Close switch (energize relay coil) on selected subunit of index <bit>.

SwitchOpen SO Open switch <bit(int)> Open switch (disengage relay coil) on selected subunit of index <bit>.

SwitchView SV Get state of a switch

<bit(int)> Get state of switch on selected subunit of index <bit>. Returns 1 if coil is energized 0 otherwise.

SwitchMask SM Mask switch from using

<bit(int)> Mask switch on selected subunit of index <bit>. Switch cannot be operated until unmasked.

SwitchUnmask SU Unmask switch for using

<bit(int)> Clear mask of switch on selected subunit of index <bit>.

SwitchMaskView SMV Get state of mask of a switch

<bit(int)> Get state of mask of switch on selected subunit of index <bit>. Returns 1 if mask is active 0 otherwise.

SubunitClear UC Clear subunit <no parameters> Clear all switches (set relays to their default state) on selected subunit.

SubunitClosureLimit UCL Get closure limit of subunit

<no parameters> Get closure limit of selected subunit. Closure limit is maximum number of switches that can be simultaneously closed on a subunit. Returns integer value.

Page B.6




Long Short

SubunitEnumerate UE Get number of subunits

<no parameters> Get number of input and output subunits on selected card. Returns: <number of input subunits>;<number of output subunits>

SubunitInfo UI Info about subunit

[input(int)] Get information about subunit. Optional parameter <input> states whether to get information about input-0 or output-1 subunit. Implicitly its output. Returns information in form: <type>;<number of rows>;<number of columns>”

SubunitSettleTime USE Get settling time of relays

<no parameters> Get time in ms that is required for relay contanct to settle down after switch operation. Returns integer value.

SubunitStatus UST Status code of subunit

<no parameters> Get status of selected subunit. Status consists of binary flags detecting various problems of subunit. Result: hex integer containing status flags.

SubunitType UTInfo about subunit in string form

[input(int)] Get string info about selected subunit. Return string contains description of the subunit. Optional parameter <input> states whether to get information about input-0 or output-1 subunit. Implicitly its output. For example: MATRIX(<columns>X<rows>)”

SubunitMaskClear UMC Clear mask on whole subunit <no parameters> Clears all mask bits on selected subunit.

SubunitMaskView UMVView state of mask on whole subunit

<no parameters> View states of all mask bits on selected subunit. Returns hex string describing mask. Each bit in hex string represents 1 bit of mask.

SubunitMaskWrite UMWWrite mask states to whole subunit

<pattern(hex string)> Writes hex string converted to bit array into subunit mask bits. Note that hex string must be started with \0x\”notation”.

SubunitView UVView states of switches on subunit

<no parameters> View states of all switches on selected subunit. Returns hex string describing states of switches. Each bit in hex string represents 1 switch.

SubunitWrite UWWrite states of switches on subunit

<pattern(hex string)> Writes hex string converted to bit array into subunit. Note that hex string must be started with \0x\”notation”.

VsourceEnableGet VEGGet voltage source enabled pattern

<no parameters> Get enabled states of selected voltage source subunit as pattern. Returns integer pattern where each bit represents one voltage source output.

VsourceEnableSet VESSet voltage source enabled pattern

<pattern(int)> Set enabled states of selected voltage source subunit. Each bit in <pattern> represents one voltage source output.

VsourceRangeGet VRG Get voltage source range

<no parameters> Get settings of range of selected voltage source subunit. Return float value.

VsourceRangeSet VRS Set voltage source range

<range(float)> Set <range> of selected voltage source subunit.

VsourceVoltageGet VVG Get voltage source voltage

<no parameters> Get voltage settings of selected voltage source subunit. Return float value.

VsourceVoltageSet VVS Set voltage source voltage

<voltage(float)> Set <voltage> of selected voltage source subunit.

XpointClose XC Close crosspoint <column(int)> <row(int)> Close switch (energize relay coil) on selected matrix subunit on position <column> <row>.

APPENDIX B

Page B.7

pickering



Long Short

XpointOpen XO Open crosspoint<column(int)> <row(int)> Open switch (disengage relay coil) on selected matrix subunit in position <column> <row>.

XpointView XV View state of a crosspoint

<column(int)> <row(int)> Get state of switch on selected matrix subunit in position <column> <row>. Returns 1 if coil is energized 0 otherwise.”

XpointMask XM Mask crosspoint from using

<column(int)> <row(int)> Mask switch on selected matrix subunit in position <column> <row>. Switch can’t be operated until unmasked.”

XpointUnmask XUUnmask crosspoint for using

<column(int)> <row(int)> Clear mask of switch on selected matrix subunit in position <column> <row>.

XpointMaskView XMVGet state of mask of a crosspoint

<column(int)> <row(int)> Get state of mask of switch on selected matrix subunit in position <column> <row>. Returns 1 if mask is active 0 otherwise.

ModeSet MS Set mode of driver

Set driver in different working mode. This feature is to be used only by experts!

MultiAccessSet MAS Set access rights for opened card

<access(int)> [card(int)] Modify access rights for selected card. <access> is 1 for exclusive access 0 for multiaccess Optional parameter [card] can be used to change access rights for unopened card.

MultiAccessGet MAG Get access rights of a card

[card(int)] Query access rights for selected card. Optional parameter [card] can be used to query access rights for unopened card. Return string describing access rights.

SubunitSelect USL Select active card and subunit

<card(int)> <subunit(int)> [input(int)] Selects active <subunit> on card number <card>. Optional parameter <input> states whether to get information about input-0 or output-1 subunit. Implicitly it’s output. When called without any parameters returns actual settings.

List LS List all cards List all cards and show their location. For opened cards more details will be displayed.

Help HE Show this helpShow help about all commands. Help <command> shows more detailed explanation of syntax and meaning of commands.

Quit Q Quit pilmon Ends work with pilmon. All resources will be freed but states of cards remain unchanged.

Example Commands - New Version of PILMon

COA Open All Cards

LS List all cards

USL 2 3 1 Selects card 2, sub-unit 3, 1=output of sub-unit 3

SC 3 Closes switch 3 on current sub-unit

USL 1 4 0 Selects card 1, sub-unit 4, 0=input of sub-unit 4

UV View states of switch on current sub-unit

Page B.8




Date post:	11-Aug-2021
Category:	Documents
Upload:	others
View:	8 times
Download:	0 times

SSH Server Manual - Pickering Downloads · 2013. 12. 18. · The SSH server is now operative and...

Documents