1. Manuals
  2. Brands
  3. Slerj Manuals
  4. Other
  5. SSR-1
  6. User manual

Slerj SSR-1 User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
SSR-1 User's Manual
Revision E
27 Feb 2018

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SSR-1 and is the answer not in the manual?

Questions and answers

Summary of Contents for Slerj SSR-1

  • Page 1 SSR-1 User’s Manual Revision E 27 Feb 2018...

  • Page 2: Table Of Contents

    Introduction ..........................4 Description ........................4 Features ..........................4 Getting Started ......................... 4 Package Contents ......................4 The SSR-1 Hardware ....................... 5 Connecting the SSR-1 ...................... 6 Using the SSR-1 ....................... 9 Functional Overview ......................10 Serial Channels ....................... 10 Record Function ......................
  • Page 3 Publication thereof does not convey nor imply any license under patent or other industrial or intellectual property rights. Slerj assumes no responsibility or liability whatsoever for any failure or unexpected operation...

  • Page 4: Introduction

    1 Introduction 1.1 Description The SSR-1 is a flexible and robust serial data recording device that takes care of the details of storing data so that you can focus on your application. Up to three streams of serial data can be recorded simultaneously, and each channel is configurable with a variety of serial and storage options.

  • Page 5: The Ssr-1 Hardware

    SSR-1 User’s Manual Rev E, 27 Feb 2018 2.2 The SSR-1 Hardware Main Connector Channel Status LEDs Insert card as shown in slot beneath board. Figure 1. Top View MicroSD Card Slot (push-push type connector) Coin Battery Holder Insert battery Figure 2.
  • Page 6 SSR-1 User’s Manual Rev E, 27 Feb 2018 WARNING: Improper removal of the backup battery can damage the SSR-1. To remove the battery, use a blunt stick to push the battery out of the holder. DO NOT PRY OR PULL THE BATTERY.

  • Page 7: Connecting The Ssr-1

    The pins of the main connector are shown in Figure 3 and described in Table 1. The default configuration of the SSR-1 provides access to the user shell (see Section 4 Interactive Shell, for details) on channel 1 and causes channels 2 and 3 to record when the digital input command pin (DI, pin 15) is pulled to ground.
  • Page 8 SSR-1 User’s Manual Rev E, 27 Feb 2018 Wiring for a typical application is shown in Figure 4. The default SSR-1 configuration is assumed. In the figure, channel 1 is connected to a standard PC serial port for shell access, allowing configuration and file system operations via a terminal application on the PC.

  • Page 9: Using The Ssr-1

    Channel 1 is configured to present the user shell. On power up, the SSR-1 displays a boot loader announcement and device details. If a channel is attached to the user shell, it will present the user shell prompt. A typical power-on sequence would produce output similar to: Slerj Boot Loader v1.0.0...

  • Page 10: Functional Overview

    SSR-1 User’s Manual Rev E, 27 Feb 2018 3 Functional Overview The SSR-1 consists of three asynchronous serial channels, a data recording subsystem, a user interface module, a real-time clock, and digital input/output for status and control. 3.1 Serial Channels...
  • Page 11 (interactive shell or control protocol).  File Type The SSR-1 supports three archive types: raw, tagged line , and time tagged archives. o When file type is raw, bytes are written to file just as they are received, and no timestamp information is attached to the data.
  • Page 12 Supported file creation modes are retry, overwrite, and append. When file mode is retry, the SSR-1 will continue to retry the file creation operation until it succeeds. File creation can fail if a file with the same name already exists. This mode is a useful complement to user definable file paths (next bullet).
  • Page 13 This field identifier is lower case.  File Size Starting with firmware version 1.0.3, the SSR-1 supports automatic file close and reopen when a size (or time) threshold is reached. Threshold values of 1 MB, 2 MB, 4 MB, 8 MB, 16 MB, 32 MB, 64 MB, 128 MB, 256 MB, 512 MB, and 1024 MB are supported.

  • Page 14: User Interface Module

    Additionally, a status line is provided for each channel (S1, S2, and S3) to indicate when the channel is recording. A bi-color (red and green) status LED is provided on the SSR-1 for each channel (Figure 1). The green segment flashes to indicate reception of serial data on the channel.

  • Page 15: Interactive Shell

    SSR-1 User’s Manual Rev E, 27 Feb 2018 4 Interactive Shell The interactive shell is designed to provide easy access to the SD card file system, device status, and configuration options. Entering ‘?’ or ‘help’ at the command prompt provides information about using the shell.

  • Page 16: System Commands

    SSR-1 User’s Manual Rev E, 27 Feb 2018 4.1 System Commands System commands provide access to general system functions including the real time clock and operational status. Table 5. System Commands Command Aliases Description clear Clears the screen. date [yyyymmdd] Sets the current date to the year, month, and day specified.

  • Page 17: Device Configuration

    (RAM) and can be saved to non-volatile memory for preservation across resets. On startup, if the contents of the non-volatile configuration memory are valid, the stored configuration is loaded and used by the SSR-1. The shell provides access to device configuration through the following commands: Table 7.

  • Page 18: Capturing The Shell

     When the previous step has been completed, the SSR-1 will send a random challenge string consisting of 4 upper case characters, and a new capture window of 5 seconds is established.
  • Page 19 Rev E, 27 Feb 2018 capture process. If the challenge string is not answered in 5 seconds, the capture process is aborted and the SSR-1 starts normally. In order to support the capture feature, a distinction is made between the active function of a channel and its configured function.

  • Page 20: Control Protocol

    0x. The & symbol represents the bit-wise AND logical operation. 5.1 Message Format Messages are exchanged between the SSR-1 and the user in the form of byte-oriented packets. Each packet has a start sequence, an ID, a payload count, an optional payload, and a checksum.

  • Page 21: General Messages

    Variable length string of bytes 5.2 General Messages General messages (Table 11) provide access to command functions and status of the SSR-1. All general messages received by the SSR-1 will be answered with a message to acknowledge (ACK), to negatively acknowledge (NACK), or to provide the requested data.
  • Page 22 All general output messages (direction = out) must be polled by the user. A message is polled by sending a message to the SSR-1 with the same message ID with zero payload. For example, to poll the All Channel Status message (ID = 0x24), construct the poll message as follows:...
  • Page 23 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.1 Record Message Record Description Requests recording to start immediately on the specified channel. Payload Length Direction Message Rate 0x10 1 to 30 bytes Payload Byte Type Notes Name Units Purpose / Comment Offset Channel (1 –...
  • Page 24 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.3 Command Status Message Command Status Description Provides the status of the record command sources. Payload Length Direction Message Rate 0x20 5 bytes polled Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 25 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.5 Disk Status Message Disk Status Description Provides the status of the disk as detected by the file system. Payload Length Direction Message Rate 0x22 8 bytes polled Payload Byte Type Notes...
  • Page 26 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.6 All Channel Status Message All Channel Status Description Provides the status of all channels. Payload Length Direction Message Rate 0x24 3 bytes polled Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 27 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.7 Set Date Message Set Date Description Sets the date. Payload Length Direction Message Rate 0x30 4 bytes Payload Byte Type Notes Name Units Purpose / Comment Offset Year (2001 – 2099) year Month (1 –...
  • Page 28 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.9 Set Time Message Set Time Description Sets the time. Payload Length Direction Message Rate 0x31 3 bytes Payload Byte Type Notes Name Units Purpose / Comment Offset Hour (0 – 23) hour Minute (1 –...
  • Page 29 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.11 Configuration Set Message Configuration Set Description Provides access to configuration functions. Payload Length Direction Message Rate 0x50 > 1 bytes Payload Byte Type Notes Name Units Purpose / Comment Offset payload...
  • Page 30 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.2.13 Reset Message Reset Description Resets the SSR-1. Payload Length Direction Message Rate 0x99 0 bytes Notes: Possible Replies: NACK_INV_LEN © 2018 Slerj, LLC www.slerj.com...

  • Page 31: Configuration Messages

    Rev E, 27 Feb 2018 5.3 Configuration Messages The Control Protocol provides a packetized interface to the configuration of the SSR-1. Operations are the same as those available through the shell. For an overview of configuring the SSR-1, refer to Section 4.3 Device Configuration. The control protocol provides access to configuration through the Configuration Set and Configuration Query messages.
  • Page 32 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.1 Load Request Load Configuration Description Loads the configuration data stored in non-volatile configuration memory. Container Configuration Set Message Configuration ID Payload Length Direction 0x01 1 bytes Payload Byte Type Notes Name...
  • Page 33 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.3 Erase Request Erase Configuration Description Erases the non-volatile configuration memory. Container Configuration Set Message Configuration ID Payload Length Direction 0x03 1 bytes Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 34 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4 Set Channel Parameter 5.3.4.1 Line Request Set Line Description Sets all communication parameters of a channel. Configuration Set Message Container Configuration ID Payload Length Direction 0x10 5 bytes Payload Byte Type...
  • Page 35 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.2 Baud Request Set Baud Description Sets baud rate for a channel. Container Configuration Set Message Configuration ID Payload Length Direction 0x11 4 bytes Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 36 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.3 Parity Request Set Parity Description Sets parity for a channel. Container Configuration Set Message Configuration ID Payload Length Direction 0x12 3 bytes Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 37 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.4 Stop Request Set Stop Description Sets stop bits for a channel. Container Configuration Set Message Configuration ID Payload Length Direction 0x13 3 bytes Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 38 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.5 Function Request Set Function Sets a channel’s function. Description Container Configuration Set Message Configuration ID Payload Length Direction 0x20 3 bytes Payload Byte Type Notes Name Units Purpose / Comment Offset Configuration ID Channel (1 –...
  • Page 39 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.6 Source Request Set Source Sets a channel’s record command source. Description Container Configuration Set Message Configuration ID Payload Length Direction 0x21 3 bytes Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 40 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.7 Soft Command Request Set Soft Command Sets the value of a channel’s internal soft command. Description Container Configuration Set Message Configuration ID Payload Length Direction 0x22 3 bytes Payload Byte Type...
  • Page 41 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.8 File Type Request Set File Type Description Sets the type of archive that a channel will record (raw or time tagged). Container Configuration Set Message Configuration ID Payload Length Direction 0x30...
  • Page 42 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.9 File Mode Request Set File Mode Description Sets the file open mode used by a channel. Container Configuration Set Message Configuration ID Payload Length Direction 0x31 3 bytes Payload Byte Type...
  • Page 43 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.10 File Path Request Set File Path Description Sets the path template used by a channel when recording. Container Configuration Set Message Configuration ID Payload Length Direction 0x33 3 to 31 bytes...
  • Page 44 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.4.11 File Size Request Set File Size Description Sets the file size threshold used by a channel. Container Configuration Set Message Configuration ID Payload Length Direction 0x34 3 bytes Payload Byte Type...
  • Page 45 5.3.5 Query Channel Parameter Queries to the configuration subsystem are performed using Configuration Query messages. When a valid query is received, the SSR-1 replies with a Configuration Query Reply. Configuration Reply uses the same message ID (0x51) as the Configuration Query. The payload of the reply depends on the request, and available configuration items are listed below.
  • Page 46 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.2 Baud Item Baud Description Provides baud rate for a channel. Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x11 4 bytes polled Payload Byte Type Notes Name...
  • Page 47 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.4 Stop Item Stop Description Provides stop bits for a channel. Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x13 3 bytes polled Payload Byte Type Notes Name...
  • Page 48 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.5 Function Item Function Provides a channel’s function. Description Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x20 3 bytes polled Payload Byte Type Notes Name Units Purpose / Comment...
  • Page 49 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.6 Source Item Source Provides a channel’s record command source. Description Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x21 3 bytes polled Payload Byte Type Notes Name...
  • Page 50 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.7 Soft Command Item Soft Command Provides the value of a channel’s internal soft command. Description Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x22 3 bytes polled...
  • Page 51 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.9 File Mode Item File Mode Description Provides the file open mode used by a channel. Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x31 3 bytes polled...
  • Page 52 SSR-1 User’s Manual Rev E, 27 Feb 2018 5.3.5.11 File Size Item File Size Description Provides the file size threshold used by a channel. Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x34 3 bytes polled...

  • Page 53: Error Codes

    SSR-1 User’s Manual Rev E, 27 Feb 2018 5.4 Error Codes The control protocol provides a unified set of error codes to simplify interpreting and displaying errors to the user. The possible error codes are listed in Table 12. Table 12. Control Protocol Error Codes...

  • Page 54: Time Tagged Archives

    All multi-byte words in the archive are big endian. Note that a software utility, including source code, is provided with the SSR-1 for parsing time tagged archives into a variety of useful formats. See section 6.3 The STTP Utility for details.

  • Page 55: Time Correlation Packet

    SSR-1 User’s Manual Rev E, 27 Feb 2018 6.2 Time Correlation Packet The time correlation packet associates the free running clock timer with the real time clock. A time correlation packet is written when the recording is started, every 10 minutes, and as the recording is stopped.

  • Page 56: The Sttp Utility

    The SLERJ Time Tagged Parser is a Windows command line utility (sttp.exe) provided with the SSR-1 to parse time tagged archives into various output types. Source code is provided under a non-restrictive (MIT) license so that it can be freely modified and incorporated into user applications.
  • Page 57 SSR-1 User’s Manual Rev E, 27 Feb 2018 Extracting this data with options -n outputfile.txt -N "%m/%d/%Y %H:%M:%S." would produce an output file: 02/03/2014 21:47:38.915 S D 0.0000122 kg 02/03/2014 21:47:39.013 S D 0.0000122 kg 02/03/2014 21:47:39.111 S D 0.0000122 kg 02/03/2014 21:47:39.207 S D...

  • Page 58: Specifications

    SSR-1 User’s Manual Rev E, 27 Feb 2018 7 Specifications 7.1 Environmental All devices manufactured and shipped after October 2017 support extended temperature operation (-40 to 85C). 7.2 Electrical Typical Unit Supply Voltage 5 VDC Supply Supply Current Idle Recording...

  • Page 59: Mechanical

    SSR-1 User’s Manual Rev E, 27 Feb 2018 7.3 Mechanical Mounting holes designed for #2 hardware Main Connector: Molex 87833-2020 Mating Connector: Molex 87568-2093 Battery: CR1220 or CR1216, 3V button cell © 2018 Slerj, LLC www.slerj.com...

  • Page 60: Revision History

    SSR-1 User’s Manual Rev E, 27 Feb 2018 8 Revision History Date Rev. Changes 8 May 2013 Initial release 17 Jan 2014 Added warning regarding battery removal. Added caution regarding ESD precautions. Restructured Table 1 to clarify pin electrical characteristics.
  • Page 61 SSR-1 User’s Manual Rev E, 27 Feb 2018 27 Feb 2018 Updated maximum baud rate to 230400 to match recent firmware versions. Added reference to the new high-speed 921k baud version. Added section to list part numbers for orderable variants.

Table of Contents