ATEN Command Line Interface Gebruikersgids

ATEN Command Line Interface

Spesifikasies

• Produk: ATEN-beheerstelsel
• Funksionaliteit: Bestuur ATEN-beheerders en uitbreidingsbokse op afstand via SSH/Telnet

Produkgebruiksinstruksies

Vestiging van 'n SSH/Telnet-sessie

1. Laai 'n SSH/Telnet-kliënt soos PuTTY af op 'n rekenaar met toegang tot die ATEN-beheerder of Expansion Box.
2. Begin die afgelaaide kliënt.
3. Vir SSH sessie:
   • Gasheernaam / IP-adres: Voer die teikenbeheerder of uitbreidingskassie se IP-adres of gasheernaam in.
   • Verbindingstipe: SSH
   • Poort: 22
4. Vir telnet sessie:
   • Gasheernaam / IP-adres: Voer die teikenbeheerder in of
     uitbreidingsboks se IP-adres of gasheernaam.
   • Verbindingstipe: Ander > Telnet
   • Poort: 23
5. Klik Open en volg instruksies op die skerm om aan te meld.

SSH/Telnet-opdragte

Help Command

• Gebruik: Vertoon instruksies vir die aktivering van die CLI-modus van die beheerder.
• Sintaksis: help
• erken: Opdrag OK – Funksie uitgevoer; Opdrag verkeerd – nie uitgevoer nie
• Example: help: vertoon instruksie van CLI-modus

Aktiveer/deaktiveer Echo Reply

• Gebruik: Aktiveer of deaktiveer outomatiese reaksie op ontvangde boodskappe.
• Sintaksis: eggo[beheer]
• Parameter: beheer: aan – aktiveer; af – deaktiveer (verstek is af)
• erken: Opdrag OK – Funksie uitgevoer; Opdrag verkeerd – nie uitgevoer nie
• Example: wie aan: stel die beheerder om outomaties op ontvangde boodskappe te reageer.

Stel Telnet Timeout Interval of Aanmelding op

• Gebruik: Stel Telnet CLI-modusinstellings op.
• Sintaksis: telnet[time-out interval][aanmeldbeheer]
• Parameter: time-out: Telnet sessie timeout interval instelling; login: Telnet-aanmeldfunksie-instelling
• erken: Opdrag OK – Funksie uitgevoer; Opdrag verkeerd – nie uitgevoer nie
• Example: telnet time-out 0 : stel die time-out interval in om nooit uit te skakel nie

Stel reekspoortinstellings op

• Gebruik: Beheer en konfigureer reekspoortinstellings.

Gereelde Vrae (Gereelde Vrae)

V: Wat moet ek doen as die SSH/Telnet-sessie nie gevestig kan word nie?
A: As die sessie nie gevestig kan word nie, meld aan by die toestelbestuurkonsole om te kyk of die toegangsleutel verander moet word.

Oor hierdie gids
Hierdie gids verskaf inligting oor die beskikbare SSH- en Telnet-opdragte om ATEN-beheerders en uitbreidingskassies op afstand te bestuur.

BELANGRIK: Konfigurasie wat via opdragreël-koppelvlak gemaak is, sal oorskryf word as 'n projek file word daarna deur ATEN Configurator (GUI) opgelaai.

Vestiging van 'n SSH/Telnet-sessie

1. Op 'n rekenaar wat toegang het tot die teiken ATEN-beheerder of uitbreidingskassie, laai 'n SSH/Telnet-kliënt af, bv. PuTTY.
   Let wel: Om die installeerder te verkry, soek “download putty” in a web blaaier.
2. Begin die afgelaaide kliënt.
3. Gebruik die volgende instellings om 'n SSH-sessie te vestig.
   

   Veld	Instelling
   Gasheernaam / IP-adres	IP-adres of gasheernaam van die teikenbeheerder of uitbreidingskassie
   Tipe verbinding	SSH
   Port	22

   Byvoorbeeldample:

4. Gebruik die volgende instellings om 'n telnet-sessie te vestig.
   

   Veld	Instelling
   Gasheernaam / IP-adres	IP-adres of gasheernaam van die teikenbeheerder of uitbreiding boks
   Tipe verbinding	Ander > Telnet
   Port	23

   Byvoorbeeldample:

5. Klik Open en volg die instruksies op die skerm om die aanmeldbewyse in te voer. 'n Sessie word gestig. Byvoorbeeldample:

Let wel: As die sessie nie gevestig kan word nie, meld aan by die toestelbestuurkonsole om te kyk of die toegangsleutel verander moet word.

SSH/Telnet-opdragte

Help

• Gebruik:
  Vertoon die instruksie om die CLI-modus van die beheerder te aktiveer.
• Sintaksis:
  help↙
• erken:
  Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
  Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.
• Example:
  help↙: vertoon instruksie van CLI-modus

Aktiveer/deaktiveer Echo Reply

• Gebruik:
  Aktiveer of deaktiveer die beheerder om outomaties op ontvangde boodskappe te reageer.
• Sintaksis:
  eggo[beheer]↙
• Parameter:
  beheer : aan – aktiveer hierdie funksie
  af – deaktiveer hierdie funksie (verstek is af)
• erken:
  Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
  Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.
• Example:
  eho on↙ : stel die kontroleerder om outomaties op ontvangde boodskappe te reageer.

Stel Telnet Timeout Interval of Aanmelding op

• Gebruik:
  Stel Telnet CLI-modusinstellings op.
• Sintaksis:
  telnet[timeout interval][aanmeldbeheer]↙
• Sleutelwoord
  time-out: Telnet-sessie-time-out-intervalinstelling
  login: Telnet-aanmeldfunksie-instelling
• Parameter:
  interval: sessie timeout in minuut. (0 beteken nooit uitteltyd nie) (verstek is 5)
  beheer: aan – aktiveer aanmeldfunksie (verstek is aan)
  af - deaktiveer aanmeldfunksie
• erken:
  Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
  Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.
• Example:
  telnet time-out 0↙ : stel die time-out interval in om nooit timeout nie
  telnet timeout 5↙ : stel die timeout interval op na 5 minute
  telnet aanmeld af↙ : deaktiveer die aanmeldfunksie

Stel reekspoortinstellings op

Gebruik:
Beheer en konfigureer reekspoortinstellings.

Sintaksis:
serial [p volgorde] [tipe stype] [baud baudrate] [dbit databit] [pariteitspariteit] [sbit stopbit] [fctrl flowctrl] [dtype datatipe] [endchar chars ] [checksumtype checksumtype] [acktime-out duur ] [beheer "data" ] [help]↙d

Sleutelwoord:

• p :poort
• tipe: reeks tipe
• baud : baud rate
• dbit: databis
• pariteit: reekspariteit
• sbit : stop bietjie
• fctrl: vloeibeheer
• dtype : datatipe
• acktimeout: tydsduur (ms) word gebruik om te wag vir die terugvoer vanaf sendack-beheer.
• endchar : spesifieke eindkarakter word gebruik om 'n volledige boodskap te identifiseer.
• kontrolesomtipe: indien nodig fw om opdragkontrolesom outomaties te bereken, ken 'n kontrolesomtipe toe
• help: wys instruksies

Parameter:

• volgorde: poort, geskei deur komma vir veelvuldige poorte * (alle poorte)
• tipe: 232, 422, 485 (verstek 232)
• baudrate: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 (verstek 9600)
• databit: 7, 8 (verstek 8)
• sparity : geen, ewe, vreemd (verstek geen)
• stoppunt: 1, 2 (verstek 1)
• flowctrl: geen, hw (verstek geen)
• datatipe: ascii, hex (verstek ascii)
• kontrolesomtipe: geen, modbus (verstek geen)
• duur: spesifieke uitteltyd (ms) (verstek 300)
• chars : eindkarakters na 'n volledige boodskap.
• beheer: lees – vertoon ontvangde boodskap van die spesifieke reekspoort
• skryf – stuur data vanaf die seriële poort. Gebruik " simbool dek data. Gebruik \x simbool om Hex-kode te stuur
• sendack – stuur data vanaf die seriële poort en vertoon ontvangde boodskap

Erkenrand:
Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.

Example:

• Reekshulp ↙ : wys instruksies
• serial p01 ↙ : vertoon die instellingsinligting van seriële poort1.
• seriële p* ↙ : vertoon die instellingsinligting van alle seriële poorte.
• reeks p01 tipe 232 baud 115200 dbit 8 pariteit geen sbit 1 fctrl geen ↙ : stel poort1 in.
• reeks p01,04,07 baud 19200 ↙ : stel poort1, 4, 7 op na baudsnelheid 19200.
• serial p02 baud 19200 ↙ : stel poort2 in op baud 19200 en gebruik verstekinstellings vir ander parameters.
• serial p02 dtype hex read ↙ : vertoon die ontvangde boodskap van poort2 in HEX-formaat.
• serial p03 skryf “sw i01 o02\r\n” ↙ : stuur die ASCII-teks 'sw i01 o02' vanaf poort3.
• serial p03 sendack “sw i01 o02\x0D\x0A” ↙ : stuur die ASCII-teks 'sw i01 o02' vanaf port3 en vertoon die terugvoer.

Konfigureer aflospoortinstellings

Gebruik:
Beheer en konfigureer aflospoorte.

Sintaksis:
aflos [p volgorde] [tpulsduur] [beheer] [help] ↙

Sleutelwoord:

• p :poort
• tpulse : geslote tydperk vir pols
• help: wys instruksies

Parameter:

• volgorde: poort, geskei deur komma vir veelvuldige poorte
• * (alle poorte)
• duur: tydperk in millisekonde.
• beheer : oop - skakel af
• toemaak – skakel aan
• pols – maak die afloskanaal toe en maak dan oop
• wissel – aflos wissel
• lees – vertoon status

erken:
Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.

Example:

• afloshulp ↙ : wys instruksies
• aflos p01 sluit ↙ : sluit poort1-kanaal.
• aflos p01 oop ↙ : oop poort1 kanaal.
• aflos p01,04,07 sluit ↙ : maak poort 1, 4, 7 afloskanale toe.
• relay p02 tpulse 500 pulse ↙ : maak poort2 500ms toe en maak dan oop.
• relay p02 read ↙ : vertoon poort2 status.

Konfigureer I/O-poortinstellings

Gebruik:
Beheer en konfigureer I/O-poorte.

Sintaksis:
io [p volgorde] [tipe iotipe] [lthresh threshold] [hthresh threshold] [tpulsduur] [kontrole] [help]↙

Sleutelwoord:

• p :poort
• lthresh : laaggebonde drempel
• hthresh : hooggebonde drempel
• tpulse : periode wat I/O op hoë vlak bly in pulsmodus
• help: wys instruksies
• LET WEL: Indien 'n parameter nie gespesifiseer is nie, sal 'n voorheen ingevoerde waarde toegepas word.
• Parameter:
• volgorde: poort, geskei deur komma vir veelvuldige poorte
• * (alle poorte)
• iotipe: droog, vdc, dout
• drempel : sneller drempel in voltage
• duur: tydperk in millisekonde.
• beheer : oop
• naby
• pols
• wissel
• lees

erken:
Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.

Example:

• io help ↙ : wys instruksies
• io p01↙ : vertoon die instellingsinligting van I/O-poort1.
• io p*↙ : vertoon die instellingsinligting van alle I/O-poorte.
• io p01 tipe droog ↙ : stel poort 1 in op droë kontakmodus.
• io p01 tipe dout ↙ : stel poort 1 op na digitale uitvoermodus.
• io p01 tipe vdc lthresh 1 hthresh 3 ↙ : stel poort 1 op na vdc-modus met drempelinstellings.
• io p01 oop ↙ : oop poort1-kanaal.
• io p01 sluit ↙ : sluit poort1-kanaal.
• io p01,04,07 sluit ↙ : sluit poort1,4,7 kanale.
• io p02 tpulse 500 pols ↙ : maak poort2 kanaal 500ms toe en maak dan oop.
• io p02 lees ↙ : vertoon poort2-status.

Konfigureer IR-instellings

Gebruik:
Beheer en konfigureer IR-poorte.

Sintaksis:
ir [p volgorde] [tipe irtype] | [baud baudrate] [dbit databit] [pariteitspariteit] [sbit stopbit] [dtype datatipe] [kontrolesomtipe kontrolesomtipe] [beheer "data"] [hulp]↙

Sleutelwoord:

• p :poort
• tipe: uitsettipe vir spesifieke uitsetpoort
• baud** : baud rate
• dbit** : databis
• pariteit** : reekspariteit
• sbit** : stop bietjie
• dtype** : datatipe
• checksumtype** : Kontroleerder/uitbreidingsboks bereken outomaties die gespesifiseerde kontrolesomtipe
• help: wys instruksies

LET WEL:
* : Hierdie sleutelwoord is vir IR-tipe
** : Hierdie sleutelwoorde is vir 232 tipe

As 'n parameter nie gespesifiseer is nie, sal 'n voorheen ingevoerde waarde toegepas word.

Parameter:

• volgorde: poort, geskei deur komma vir veelvuldige poorte * (alle poorte)
• irtipe: ir, 232 (verstek ir)
• baudrate: 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 (verstek 9600)
• databit: 7, 8 (verstek 8)
• sparity: geen, ewe, vreemd (verstek geen)
• stoppunt: 1, 2 (verstek 1)
• datatipe: ascii, hex (verstek ascii)
• kontrolesomtipe: geen, modbus (verstek geen)
• beheer: skryf – stuur IR-kode of RS232-data

erken:
Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.

Example:

• hul hulp ↙ : wys instruksies
• ir p01 ↙ : vertoon die instellingsinligting van IR-poort1.
• ir p* ↙ : vertoon die instellingsinligting van alle IR-poorte.
• ir p01,04,07 tipe 232 ↙ : stel poort1,4,7 op na RS232 tipe
• ir p01 tipe 232 baud 115200 dbit 8 pariteit geen sbit 1 kontrolesom tipe modbus↙ : stel poort1 op na RS232 tipe en die instellings
• ir p02 skryf dtype hex "0a0b0c" ↙ : stuur hex formaat data 0a0b0c vanaf poort2
• ir p02 baud 19200 ↙ : stel poort2 op na baud 19200 en gebruik die verstekinstellings vir ander parameters.
• ir p02 skryf “sw i01 o02\r\n” ↙ : stuur die ASCII-teks 'sw i01 o02' vanaf poort2.
• ir p02 skryf “sw i01 o02\x0D\x0A”↙ : stuur die ASCII-teks 'sw i01 o02' vanaf poort2.

Herlaai

Gebruik:
Herlaai die kontroleerder.

Sintaksis:
herlaai↙

erken:
Opdrag OK↙ : Opdrag is korrek en die funksie word uitgevoer.
Opdrag verkeerd↙ : Opdrag en/of parameters is verkeerd en word nie uitgevoer nie.

Example:
herlaai↙ : herlaai toestel