GeoSwitch User Manual 2 / 66 Document Revision Version Date Modification Prepared Checked Released 03.11.2014 Document created 13.03.2015 Various corrections in text and figures. Added information about configuration of GeoSwitch, GeoSwitch Configurator software, Console Commands, LCD display and push buttons, MODBUS registers.
Page 3
GeoSwitch User Manual 16.11.2023 / V21 3 / 66 LCD Display and Push Buttons chapters. Corrected chapters Firmware Programming or Upgrade, Security of LCD Menus, "Appendix A. MODBUS Registers". Removed 115200 from list of baud-rates of MODBUS interface. Notes added about MODBUS address and baud-rate change application.
Page 4
Copyright Notice No part of this document may be reproduced without the prior written consent of GeoSIG Ltd. Software described in this document is furnished under a license and may only be used or copied in accordance with the terms of such a license.
5 / 66 Table of Contents 2.2.1. Limitation of Warranty ........................15 3.2.1. Main Connector ..........................18 3.2.2. GeoSwitch Cable ........................... 19 3.2.3. USB Console Socket ........................19 3.2.4. Battery Connector .......................... 19 3.3.1. LEDs .............................. 19 3.3.2. LCD ..............................19 3.5.1.
Page 6
GeoSwitch User Manual 6 / 66 Appendix B. Error Codes ....................62 Appendix C. Warning Codes ....................64 Appendix D. Cable Drawing ....................65 Appendix E. Connection to GeoSwitch with supplied cable ..........66 GS_GeoSwitch_UserManual_V21.doc...
Page 7
7 / 66 Table of Appendices Appendix A. MODBUS Registers ..................57 Appendix B. Error Codes ....................62 Appendix C. Warning Codes ..................... 64 Appendix D. Cable Drawing....................65 Appendix E. Connection to GeoSwitch with supplied cable ..........66 GS_GeoSwitch_UserManual_V21.doc...
GeoSIG instruments are constantly being improved. Although the manual you receive along with your instrument corresponds to the actual software versions, you are advised to check the GeoSIG web page periodically for the most recent version of this document, and especially after performing any software upgrades.
Page 9
Please consult the battery manufacturer’s website for the latest operating, maintenance and safety guidelines. Please contact GeoSIG in writing if the specific safety, operating, maintenance and disposal information for your battery type can’t be found.
Page 10
GeoSwitch User Manual 10 / 66 GS_GeoSwitch_UserManual_V21.doc...
Page 11
11 / 66 GeoSIG Cybersecurity Recommendations GeoSIG instruments, as described in their documentation, have built-in security and safety features against unauthorised access or use. However, ultimately it is the user’s responsibility to ensure the safe and secure usage of our instruments based on their actual implementation. No factory delivered solution can fit each and every possible scenario.
Page 12
10. Software / Firmware updates Networked devices must only run software/firmware that are updated according to supplier’s guidelines. A periodical check of any available updates from the supplier must be sought. Please contact GeoSIG Ltd if you require any further advice or clarification. GS_GeoSwitch_UserManual_V21.doc...
Random Access Memory. Read-Only Memory. Real Time Clock. Redundant Quadruple Matrix. Samples Per Second. Seismic Switch or GeoSwitch. Software. High level program for CPU. User Interface. Universal Serial Bus. Direct current. This symbol indicates a direct current (DC) power line derive from an alternating current (AC) power source.
Page 14
This is a reliable and easy to use device, and at the same time a sophisticated product, which requires care, attention and know-how in configuring, installing, operating and maintenance. The GeoSwitch should never be used to switch main AC power. It should always be used in conjunction with appropriate high-power relays.
5 years parts and maintenance support commitment. If GeoSIG receives notice of such defects during the warranty period, GeoSIG shall at its option either repair (at factory) or replace free of charge hardware and software products that prove to be defective. If GeoSIG is unable, within a reasonable time to repair or replace any cabinet to a condition as warranted, buyer shall be entitled to a refund of the purchase price upon return of the cabinet to GeoSIG.
Page 16
GeoSwitch User Manual 16 / 66 3. Description 3.1. Housing The instrument comes with an UV stabilized Polycarbonate housing with UL94-HB flammability rating and mounting flanges on both sides. These mounting flanges allow easy fixation of the instrument on the ground, wall or any other surface.
Page 17
17 / 66 3.2. Connectors The GeoSwitch instrument has three connectors – Main connector, USB Console connector and the LiPo Backup Battery connector.. The Main Connector must be only accessed during the first installation of the instrument. To access this connector the transparent cover and the internal black cover must be removed.
K3_NO Normally opened contact of relay 3 Each of three alarm relays of the GeoSwitch has 3 contacts, where one Common (Kx_CMN) contact will be connected to Normally Closed (Kx_NC) in case the instrument is not powered. Figure 4. Schematic of Relay Contacts.
GeoSwitch User Manual 16.11.2023 / V21 19 / 66 3.2.2. GeoSwitch Cable Please refer to Appendix D for cable drawing with pin colour code 3.2.3. USB Console Socket This is a standard USB type B socket, which can be interconnected with computer to configure the GeoSwitch.
Maximal voltage is 28 VDC. Average power consumption of the GeoSwitch is around 0.3 W. HW of GeoSwitch prior to version 3 has supercap as main backup power source. HW version 3 has Li-Po battery as main backup power source.
• If the instrument will be powered in the field from a 115 / 230 VAC supply, an external AC/DC power supply is required. The GeoSwitch cannot be connected directly to 115 / 230 VAC. The VAC supply must consist of Phase, Neutral and Protection Earth.
The unit must be fixed rigidly on the foundation. For that purpose, the housing has mounting flanges for fixation, where two or four M4 screws with washers should be used. The GeoSwitch contains an internal offset correction. Therefore the instrument can be installed on the floor, wall or any other oriented surface without any limitations.
Pinout of the Main Connector can be seen in chapter 3.2.1. It is required to connect relays to controlled equipment in such a way, so that in case of power outage for GeoSwitch, its relays should block operation or activate brakes of controlled equipment for safety reasons.
Page 24
GeoSwitch User Manual 24 / 66 Once the protective panels have been removed, the GeoSwitch internal electronic boards and battery will be visible as shown in the figure below. For ease of installation and to avoid wrong connections, the internal battery is provided with a short cable that has a polarised connector.
Page 25
This chapter gives an overview about the normal operation the instrument in a network or as a standalone unit. 5.1. Interfaces of the GeoSwitch Generally, GeoSwitch has LCD display, LEDs, push buttons, Main Connector and Console Interface (USB). Main Connector allows connecting: • External power source.
The GeoSwitch does not have any main power switch, so its power need to be disable externally. Because of its internal backup power source it is required to wait up to 400 seconds until GeoSwitch will completely switch off. Alternatively, GeoSwitch can be reset and powered off through the Clear Switch input if it was configured to reset the device and external power is off.
GeoSwitch. 5.5. System Test Main functionality of the GeoSwitch can be tested by means of the “System Test” LCD menu or by the “systest” console command. System Test will sequentially make following actions: •...
6.1. General STA/LTA feature added from version 1.1.0 of GeoSwitch FW. At first start or after a restart (reboot), the GeoSwitch needs to stabilize its signal filters based on actual ambient conditions and vibrations, to achieve higher accuracy. This may take up to 1-2 minutes during which STA/LTA and Threshold triggering functions disabled.
– when alarm state alternate between set and unset state periodically until fault will heartbeat happen. Relay contacts can be used for external monitoring of "A'm alive" state of GeoSwitch. • – when STA/LTA at corresponding axis exceeds threshold value of STA/LTA.
Applicable only for threshold, vector, sta_lta, sta_lta_vector usage of relay. Default is 0 (0 seconds). 6.1.9. Relay Beeper The GeoSwitch can beep three times (500 ms beep, 500 ms silence) at start of each 10 seconds if alarm is active for specified relay. Can be disabled or enabled.
6.1.14. MODBUS Slave Address Change of this setting will apply after reboot only. The GeoSwitch MODBUS interface can be configured to use one of addresses from range 1-247. Default is 1. 6.1.15. MODBUS Baud-rate Change of this setting will apply after reboot only.
57600 Default is 19200. 6.1.16. Time of RTC The GeoSwitch has RTC which counts local time. Its time can be set to current time. Supported range for years is 2000..2099. 6.1.17. Comment for Device This value is write-protected and can be set up at factory only.
Event buffers preserved if external power disabled and internal backup power of GeoSwitch is completely exhausted. Additionally, event buffers preserved during restart of GeoSwitch by ClearSwitch input. But, events registered after last preservation of events will be lost if GeoSwitch is restarted by Reset button (S501). 6.2.1. Event Types Registered events can be following types: •...
Page 35
Figure 13: About GeoSwitch Configurator SW. Connect the GeoSwitch to a USB port of a PC and switch on the GeoSwitch if not already done. Press the Disconnected button or use menu Tools/Connect and a connection dialog window will appear. It is required to choose COM port of the GeoSwitch device and baud-rate.
Page 36
GeoSwitch User Manual 36 / 66 The GeoSwitch Configurator will automatically fetch the state of the GeoSwitch device and reflect it in the GeoSwitch Configurator. State of ALARM, ERROR and WARNING LEDs is reflected by states of corresponding indicators/buttons at bottom of window.
Page 37
GeoSwitch User Manual 16.11.2023 / V21 37 / 66 The “Errors & Warnings” tab reflects presence of any errors and warnings. Figure 16: Errors & Warnings Tab. GS_GeoSwitch_UserManual_V21.doc...
Page 38
GeoSwitch User Manual 38 / 66 The “Device” tab reflects factory set information such as device Type, Serial Number, Comment, dates of Production, Calibration, and Testing. Additionally, this tab shows FW version, HW configuration, internal voltages at backup power source of RTC, main backup power source, Main, Input and System information.
Page 39
GeoSwitch User Manual 16.11.2023 / V21 39 / 66 The “Device Relay” and “Device Setup” tabs reflect current setup of device, allow changing configuration values and writing (Apply) changes into the GeoSwitch device. Figure 18: Device Relay Tab. GS_GeoSwitch_UserManual_V21.doc...
Page 40
GeoSwitch User Manual 40 / 66 Figure 19: Device Setup Tab. Change of MODBUS address and/or baud-rate will be applied after reboot only. The File menu allows to Save configuration into a file and/or Load it when required. Figure 20: File menu.
Any serial terminal SW (hyperterminal, minicom, kermit, teraterm, ucon or other) can be used to communicate through Console Interface (USB). Connect the GeoSwitch to a USB port of PC and switch on the GeoSwitch power if not already done. Configure serial terminal SW to use 115200 bauds, 8 bit, no parity, 1 stop bit.
Page 42
Data printed as X, Y, Z triplet. Command for debugging purposes only. Not for use by end users. voltage rtc|diodes|backup|input Show voltages of the GeoSwitch power supplies in millivolts. writeprotection State of Write Protection ('1' means write protected). Show information about running threads.
Page 43
Show or set up inversion of relay contacts. systest Run system test. systime Show number of ticks from OS startup. Counted in milliseconds for GeoSwitch V1. Overflows each 65536 milliseconds. time [YYYY/MM/DD hh:mm:ss] Show or set up local time. lock PASSWORD Lock data write operations by password to forbid parameters change.
Page 44
GeoSwitch User Manual 44 / 66 message Error: wrong password. version Show firmware version. warnings [code|clear] Show warnings in textual format (default) or as HEX-code, or clear warnings. See appendix for warning codes. GS_GeoSwitch_UserManual_V21.doc...
GeoSwitch User Manual 16.11.2023 / V21 45 / 66 6.4.2. Console Commands with Write Protection Option and Locking Support Following commands can be used for setup only at GeoSIG factory, because they are write-protected. Command Functionality comment [STRING] User defined string for device. 32 ASCII character maximum.
Page 47
The sswui is a CLI SW for PC and can be used for communication through MODBUS interface over serial bus (RS485 or RS232). Connect the GeoSwitch to a serial port of PC and apply power to the GeoSwitch if not already done. The Instrument uses 19200 bauds, 8 bit, no parity and 1 stop bit by default.
Page 48
Save configuration to a file? (Y/N)...> Press ‘Y’ key to save settings into a configuration file. Configuration of GeoSwitch can be read from configuration file and put into the GeoSwitch by command $ sswui –a put-config –c sswui.conf Start to write holding registers...
Page 49
49 / 66 7. LCD Display and Push Buttons STA/LTA feature added from version 1.1.0 of GeoSwitch FW. Change of MODBUS address and/or baud-rate will be applied after reboot only. After start-up, the top-level screen reflects current date, time and counter of seconds remaining for end of band-pass filter stabilization.
Page 50
GeoSwitch User Manual 50 / 66 Figure 23: Structure of the LCD Menus. 7.1. Security of LCD Menus Note: feature added from version 1.0.9 of GeoSwitch firmware. GS_GeoSwitch_UserManual_V21.doc...
If locking code was set, then user will hear cautionary double beep when trying to change other settings from LCD menu. Any attempt to change locked menu item will be indicated by GeoSwitch by double beep and "Menu item is locked" message at LCD display.
The GeoSwitch allows to program application code into internal Flash memory through UART interface. The GeoSwitch device has a “USB Console” port, which organized with help of a USB to UART converter. This port is as virtual COM port in the Linux/Windows OS and allows FW programming.
GeoSwitch User Manual 16.11.2023 / V21 53 / 66 8.3. Firmware Programming Run the “STM32CubeProgrammer” software. Select “UART” as communication port. Select the COM port name and click “Connect” button. Leave Baud-rate and Parity settings to 115200 and Even. Figure 25: Communication settings for STM32CubeProgrammer.
Page 54
GeoSwitch User Manual 54 / 66 The “STM32CubeProgrammer” will inform about successful connection with the STM32 MCU of the GeoSwitch (Device). Figure 26: Information about successful connection of STM32CubeProgrammer with STM32 MCU. GS_GeoSwitch_UserManual_V21.doc...
Page 55
GeoSwitch User Manual 16.11.2023 / V21 55 / 66 Select “Erasing & Programming” from the menu on the left. Specify location of the ssw-fw-X.X.X.hex file in the “Browse” field. Select “Verify programming” in the programming options list. Click “Start Programming” button and programming with verification will start.
Page 56
“Download verified successfully” message will be printed at the end. Figure 28: "Programming verified successfully" message. Click “Disconnect” button. Disconnect external power source from the GeoSwitch device. Close pins 2-3 of the JP502 jumper on the GeoSwitch board. Connect external power source back again. GS_GeoSwitch_UserManual_V21.doc...
GeoSwitch User Manual 16.11.2023 / V21 57 / 66 Appendix A. MODBUS Registers MODBUS Holding Registers with Write Protection Address Data Type Data Name Words Comment 1000 char type[16] String with device type. 1008 char serial_num[8] String with serial number.
Page 58
GeoSwitch User Manual 58 / 66 • 2 – 1.1 - 7.7 Hz; • 3 – 2.0 - 3.0 Hz; • 4 – 0.1 - 15.0 Hz. 2004 uint16_t clearswitch_type Type of Clear Switch input. Available values: • 0 – Events Clear;...
Page 59
GeoSwitch User Manual 16.11.2023 / V21 59 / 66 2036 uint16_t event_fifo_clear1 Clear events inside of FIFO for relay 1. Available values: • 0 – do nothing; • 1 – clear events. 2037 uint16_t event_fifo_clear2 Clear events inside of FIFO for relay 2.
Page 60
GeoSwitch User Manual 60 / 66 3007 uint16_t relay_is_set[3] Status of relays. 3010 uint16_t State of write protection ('1' means write protected). 3011 uint16_t voltage[4] Voltages at test points in mV. 3015 uint16_t error_status_msb Error status of instrument. 3016 uint16_t error_status_lsb Error status of instrument.
Page 61
GeoSwitch User Manual 16.11.2023 / V21 61 / 66 data[1] = 0. data[2] = 0. Event data for combined relay usages, like ThresholdFault or alike, contain data corresponding to exact event type from table above. GS_GeoSwitch_UserManual_V21.doc...
GeoSwitch User Manual 62 / 66 Appendix B. Error Codes The GeoSwitch has 32-bit Error register, where each error encoded as a 1-bit flag. Here is a table with error codes. Error Definition Error HEX Error Text Comment Code ERR_CANNOT_INIT_MODBUS...
Page 63
GeoSwitch User Manual 16.11.2023 / V21 63 / 66 ERR_SHELL_INIT_FAILED 0x0200 0000 Schell init Failed initialization of console shell. Can happen only in case of FW bug. ERR_INVALID_TIME_TO_SET 0x0400 0000 RTC time wrong Attempt to setup RTC by wrong value of time.
GeoSwitch User Manual 64 / 66 Appendix C. Warning Codes The GeoSwitch has 32-bit Warning register, where each warning encoded as a 1-bit flag. Here is a table with warning codes. Warning Text Warning Warning Comment HEX Code Text WRN_EVT_PURGED...
GeoSwitch User Manual 66 / 66 Appendix E. Connection to GeoSwitch with supplied cable If the GeoSwitch comes with a preinstalled cable, it is connected as shown below: Connector Colour Name Comment White +9-28 Power line for external power supply...
Need help?
Do you have a question about the GeoSwitch and is the answer not in the manual?
Questions and answers