SSR-1 User`s Manual
Contents
1. Message Command Status Description Provides the status of the record command sources ID Payload Length Direction Message Rate 0x20 5 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 status bitfield Status bit 7 reserved bit 6 channel 3 soft command bit 5 channel 2 soft command bit 4 channel 1 soft command bit 3 reserved bit 2 PWM input valid bit 1 PWM input 2ms as opposed to 1ms bit 0 digital input DI pin high 1 U2 width usec PWM pulse width 3 U2 period usec PWM period Notes 1 This message is polled by sending a message with ID 0x20 and no payload 5 2 4 Card Status Message Card Status Description Provides the status of the SD card as detected by the socket ID Payload Length Direction Message Rate 0x21 1 byte out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 status bitfield Status bits 7 3 reserved bit 2 Card is write protected bit 1 Card is not inserted bit 0 Card is not initialized Notes 1 This message is polled by sending a message with ID 0x21 and no payload SLERJ 5 2 5 Disk Status Message Disk Status Description Provides the status of the disk as detected by the file system ID Payload Length Direction Message Rate 0x22 8 bytes out poll2. 5 3 4 2 Baud Request Set Baud Description Sets baud rate for a channel Container Configuration Set Message Configuration ID Payload Length Direction Ox11 4 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U2 baud baud 100 Baud rate divided by 100 Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK_INV_LEN NACK_INV_CH NACK_INV_BAUD SLERJ 5 3 4 3 Parity NACK_INV_LEN NACK_INV_CH NACK_INV_PARITY Request Set Parity Description Sets parity for a channel Container Configuration Set Message Configuration ID Payload Length Direction 0x12 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 UI parity Parity bits 7 2 reserved bits 1 0 parity 0 none 1 odd 2 even Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK SLERJ 5 3 4 4 Stop NACK INV LEN NACK INV CH NACK I
3. SLERJ 5 2 1 Record Message Record Description Requests recording to start immediately on the specified channel ID Payload Length Direction Message Rate 0x10 to 30 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset yP P 0 U1 1 channel Channel 1 3 1 BN 2 path Path Template to set prior to recording Notes 1 The configured channel function must already be record Otherwise this command will have no effect This command sets the channel command source to soft and sets the soft command to true 2 Path is optional and may be omitted In that case recording will begin using the currently defined path template Possible Replies ACK NACK_INV_LEN NACK_INV_CH NACK_INV_PATH_LEN NACK_PATH_SYNTAX NACK_PATH_INV_TOKEN NACK_PATH_SEQ NACK_PATH_XLEN 5 2 2 Stop Message Stop Description Requests the specified channel to stop recording immediately ID Payload Length Direction Message Rate Ox11 byte in Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 1 channel Channel 1 3 Notes 1 The configured channel function must already be record Otherwise this command will have no effect This command sets the channel command source to soft and sets the soft command to false Possible Replies ACK NACK INV LEN NACK INV CH SLERJ 5 2 3 Command Status
4. 2 U1 month Month 1 12 3 U1 day Day of month 1 31 Notes Possible Replies ACK NACK_INV_LEN NACK_INV_DATE 5 2 8 Date Message Date Description Provides the date ID Payload Length Direction Message Rate 0x30 6 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U2 year Year 2001 2099 2 U1 month Month 1 12 3 Ul day Day of month 1 31 4 U1 doy Day of year 1 366 5 UI wday Weekday 0 Sunday 1 Monday 6 Saturday Notes 1 This message is polled by sending a message with ID 0x30 and no payload SLERJ 5 2 9 Set Time Message Set Time Description Sets the time ID Payload Length Direction Message Rate 0x31 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 hour Hour 0 23 1 U1 minute Minute 1 59 2 U1 second Second 1 59 Notes Possible Replies ACK NACK INV LEN NACK INV TIME 5 2 10 Time Message Time Description Provides the time ID Payload Length Direction Message Rate 0x31 5 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 hour Hour 0 23 1 U1 minute Minute 1 59 2 U1 second Second 1 59 3 U2 msec millisecond 0 999 Notes 1 This message is polled by sending a message with ID 0x31 and no payload SLERJ
5. 256 MB 102 512 MB 11 1024 MB 12 hour 13 day 14 week 15 off Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK_INV_LEN NACK_INV_CH SLERJ 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 5 3 5 1 Line Item Line Description Provides all communication parameters of a channel Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x10 5 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 CID Configuration ID 1 U1 channel Channel 1 3 2 Ul line Line Parameters bits 7 6 parity 0 none 1 odd 2 even bits 5 4 stop bits 0 1 stop bit 1 1 5 stop bits 2 2 stop bits bits 3 0 reserved 3 U2 baud baud 100 Baud rate divided by 100 Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the
6. 0x51 out Configuration Query 0x99 in Reset Direction is from the SSR 1 s point of view SLERJ ACK messages have ID 0x90 with a single payload byte that is the message ID being acknowledged For example an ACK for a Record message ID 0x10 would comprise the following Header Payload Checksum Start Start2 ID Count Payload Cksuml Cksum2 0x81 OxAl 0x90 OxOI 0x10 OxAT OxC2 NACK responses to general messages have ID 0x91 and two payload bytes The first payload byte is the message ID that is being negatively acknowledged The second payload byte indicates the reason for the negative acknowledgement For example a NACK for a Record message that was rejected because an invalid channel number error code 0x02 was specified would be constructed as Header Payload Checksum Start Start2 ID Count Payload Cksum1 Cksum2 0x81 OxAl 0x91 0x02 0x10 0x02 OxA5 0x6C For a list of error codes see Section 5 4 Error Codes 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 Header Checksum Start Start2 ID Count Cksuml Cksum2 0x81 OxAl 0x24 0x00 0x24 0x48
7. 5 2 11 Configuration Set Message Configuration Set Description Provides access to configuration functions ID Payload Length Direction Message Rate 0x50 gt 1 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 BN 1 payload Payload to pass to the configuration subsystem Notes 1 The payload is passed to a configuration subsystem that handles it as a configuration request Generally the first byte of the payload specifies the configuration action or item to be affected Details on the control protocol configuration subsystem are provided in Section 5 3 Configuration Messages Possible Replies Depends on the payload See Section 5 3 Configuration Messages for details 5 2 12 Configuration Query Message Configuration Query Description Provides access to configuration data ID Payload Length Direction Message Rate 0x51 1 byte in Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 item Configuration item that is requested Notes Possible Replies NACK_INV_LEN NACK_INV_CH A Configuration Query Reply Section 5 3 5 Query Channel Parameter SLERJ 5 2 13 Reset Message Reset Description Resets the SSR 1 ID Payload Length Direction Message Rate 0x99 0 bytes in Notes Possible Replies ACK NAC
8. Payload length is the length of the container message payload Possible Replies ACK SLERJ 5 3 4 10File 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 in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 BN 3 path File Path Template Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload 3 See Section 3 2 Record Function for details on path templates Possible Replies ACK NACK_INV_LEN NACK_INV_CH NACK_PATH_LEN NACK_PATH_SYNTAX NACK PATH TOKEN NACK PATH SEQ NACK PATH XLEN SLERJ 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 in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 size File Size bits 7 4 reserved bits 3 0 file size 0 off 1 1MB 2 2MB 3 4MB 4 8 MB 5 16 MB 6 32 MB 7 64 MB 8 128 MB 9
9. Write Tagged data to dat file m mxd file Write both TCPs and tagged data to mxd file SLERJ Time Correlation Packet output example RunTime ms Year Month Day Hour Minute Second 4196 2013 3 25 9 52 4 625 604196 2013 3 25 10 2 3 628 1204196 2013 3 25 10 12 2 486 Tagged Data output example RunTime ms count HexBytes 4196 20 322E323530333630652B303520322E3339343433 4198 23 30652D3034202D312E343530303639652D303420322E37 4200 23 3637343235652D303420312E373134373036652D303120 Mixed output example 4196 2013 3 25 9 52 4 625 4196 20 322E323530333630652B303520322E 3339343433 4198 23 30652D3034202D312E343530303639652D303420322E37 604194 23 3032202D352E353633313634652D303120312E32323636 604196 2013 3 25 10 2 3 628 604196 23 3330652D303220332E313334343333652B303020302037 SLERJ 7 Specifications 7 1 Electrical Min Typical Max Unit Supply Voltage 4 5 32 VDC Supply Current 5 VDC Supply Idle 30 mA Recording 90 mA 12 VDC Supply Idle 14 mA Recording 38 mA 24 VDC Supply Idle 9 mA Recording 21 mA Digital Input Characteristics Channel 3 Rx DI PI Res Low level input voltage 1 37 V High level input voltage 1 85 V Schmitt trigger hysteresis 100 mV Weak pull up equivalent resistor 25 40 55 kQ Digital Output Characteristics Channel 3 Tx S1 S3 Low level output voltage 8mA 0 4 V High le
10. 1 3 2 U1 function Function bits 7 2 reserved bits 1 0 function 0 disabled record 2 control 3 shell Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ 5 3 5 6 Source Item Source Description Provides a channel s record command source Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x21 3 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 Ul source Source bits 7 3 reserved bits 2 0 source 0 soft soft command true on reset 1 soft soft command false on reset 2 dig DI pin record when high 3 dig DI pin record when low 4 pwm PI pin record when 2ms 5 pwm PI pin record win 1ms Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ
11. 5 3 5 7 Soft Command Item Soft Command Description Provides the value of a channel s internal soft command Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x22 3 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 soft Soft Command bits 7 1 reserved bit 0 soft command 0 false 1 true Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number 5 3 5 8 File Type Item File Type Description Provides the type of archive that a channel will record raw or time tagged Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x30 3 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 CID Configuration ID 1 U1 channel Channel 1 3 2 UI type File Type bits 7 1 reserved bit 0 file type O raw 1 time tagged Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload
12. A hardware See Product Change Notice PCN 14 01 18 May 2015 Added example wiring diagram to section 2 3 Connecting the SSR 1 Added example shell session to section 2 4 Using the SSR 1 Clarified the Soft Command parameter in section 3 2 Record Function Referenced the STTP version 1 1 and ANOO2 in section 6 3The STTP Utility Added dimensions drawing to section 7 2 Mechanical General cleanup of typos and wording
13. available with 3 3 V CMOS channels instead of RS 232 Contact us for details Up to 115200 baud recording on all channels Wide supply voltage 4 5 to 32VDC Small size 1 65 x 1 23 x 0 45 inches 42 x 32 x 12 mm Supports MicroSD and MicroSDHC cards FAT12 FAT16 and FAT32 file system support Long File Name support Support for raw and time tagged archives Battery backed real time clock powered by an onboard button cell battery Flexible record control digital input PWM input software controlled or automatic User shell for configuration and file system operations Binary control protocol for machine automation Flexible recording modes overwrite append user defined path and file names etc 2 Getting Started 2 1 Package Contents The Serial Recorder is packaged with The SSR 1 Serial Recorder Mating connector Molex 87568 2093 with 9 inch ribbon cable Lithium button cell battery U S shipments only A FAT32 formatted MicroSD card with o SSR 1 Users Guide o puttytel terminal emulator o sttp time tagged archive parser with source code and o anexample Windows control protocol utility with source code SLERJ 2 2 The SSR 1 Hardware Figure 1 Top View F S 1 ad EI Us Pi eu ig m eo tu es T ee ee ee ae ee ec ee o Figure 2 Bottom View Insert battery as shown SSR 1 User s Manual Rev D Main Connector u A 89 E 7 e m d Channel Status Insert card as show
14. cls Clears the screen Aliases clear date time 20130327 102840 gt The shell supports line editing and keeps a history of recently used commands The ANSI escape sequences shown in Table 4 are supported Table 4 Shell Line Editing Sequences Keyboard Key Alternate Function Sequence Up arrow p Recall the previous command to the command line Down arrow n Recall the next command to the command line This is only available when up arrow has been used to recall a previous command Home a Move the cursor to the start of the command line End AZ Move the cursor to the end of the command line Left arrow Ak Move the cursor left one character Right arrow Move the cursor right one character Ctrl Left arrow b Move the cursor left backward one word Ctrl Right arrow f Move the cursor right forward one word The caret indicates use of the Ctrl key with the letter In the description of individual commands below the following conventions are used indicates optional parameters identifies a set of choices separated by choose one indicates a variable defined in the help text SLERJ 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 cls clear Clears the screen date yyyymmdd Sets t
15. collected The base time stamp is followed by a series of frames that are composed of an incremental time stamp fractional second within the base time stamp window and a group of bytes that were received during the increment The data packet is terminated by a Fletcher checksum as defined in section 5 1 Message Format Table 13 Time Tagged Data Packet Element Bytes Description Pocket Meadar 2 Packet start sequence 0x82 0xA2 Run Time 4 Current run time in seconds Frame repeated until an mSec_Count value of OXFFFF is encountered Fractional second and number of bytes for this frame mSec Count 2 bits 15 7 milliseconds 2 bits 6 0 number of bytes to follow n The n bytes that were received in the time window leading up to this packet frame Data n End Sequence 2 OxFFFF invalid mSec Count Fletcher checksum calculated between Run Time and End Sequence Checksum 2 l inclusive SLERJ 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 Table 14 Time Tagged Time Correlation Packet Element Bytes Description Packet Header 0x82 OxA3 2 Packet start sequence Run Time 4 Current run time in milliseconds Real Time Clock word 0 bits 15 4 year 2001 2099 bits 3 0
16. month 1 12 word 1 RTC Time 6 bits 15 11 day 1 31 bits 10 6 hour 0 23 bits 5 0 minute 0 59 word 2 bits 15 10 second 0 59 bits 9 0 milliseconds 0 999 Checksum 2 Fletcher checksum calculated between Run Time and RTC Time inclusive 6 3 TheSTTP 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 Given a time tagged archive the utility can produce the original raw stream with no timing information a time tagged correlation packet file a data packet file that has a line for each frame and a mixed file that interlaces time correlation packets with data packets Additionally version 1 1 of the STTP utility available at the Slerj website is able to directly generate time stamped line output from archives that contain recordings of line oriented serial data See Application Note AN002 STTP Timestamped Lines for details All of the non raw outputs are space delimited text files Data bytes are represented as a series of hexadecimal text characters An example of each of the textual output files is below Usage of the sttp utility is summarized by its help output usage sttp exe options infile options h Include headers in tcp and dat files r raw file Write raw stream data to raw file t tcp file Write Time Correlation Packets to tcp file d dat file
17. 0xC2 lt Config Query NACK where OxEC is an error code as defined in Section 5 4 Error Codes and OxC and OxC2 are appropriately calculated checksums SLERJ 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 in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK INV LEN NACK INV NV 5 3 2 Save Request Save Configuration Description Stores the working configuration data in non volatile configuration memory Container Configuration Set Message Configuration ID Payload Length Direction 0x02 1 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK INV LEN SLERJ 5 3 3
18. D R3 GND R2 LU F D l ifa EI GND R1 LE p E Figure 3 Main Connector View looking into the face of the connector Table 1 Main Connector Pins Pin ID Description 1 Vsup Supply voltage 4 5 32 VDC 2 Vret Supply return tied to GND onboard the SSR 1 37 T1 T2 Asynchronous serial transmitter output for channels 1 and 2 4 8 R1 R2 Asynchronous serial receiver input for channels 1 and 2 11 T3 Asynchronous serial transmitter output for channel 3 124 R3 Asynchronous serial receiver input for channel 3 16 18 20 Sx Status indication for channel x High level indicates that the channel is recording 154 DI Digital input record command 174 PI PWM input record command 19 res Reserved See Section 7 1 Electrical for detailed electrical specifications RS 232 compatible 3 3 3V CMOS output 5V tolerant TTL compatible 3 3V CMOS input Internally pulled up to 3 3 VDC SLERJ 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 Channel 2 records data from an RS 232 device and channel 3 records data from a TTL compatible device when the Close to Record switch is closed PC RS 232 Serial Port
19. DE9 Male Close to Record a L ril GND T3 GND T2 GND T l F Vsup Ta f W1 Optional External Status Indication Figure 4 Tvpical application wiring using the default SSR 1 configuration SLERJ 2 4 Usingthe SSR 1 The SSR 1 is shipped in default configuration which sets all channels to 115200 baud 8 data bits no parity and 1 stop bit Channels 2 and 3 are configured to record when DI is pulled low 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 MK Slerj HW SSR1 MG 1608747 MD SSR 1 SN 1 MV 22T SSR 1 Shell gt As an example of shell usage consider changing the command source for channel 3 to dig so that the device records when the DI pin is high In the following sequence lt enter gt means pressing the Enter Return key to execute the command in the shell With the SSR 1 shell connected to a terminal program type config lt enter gt to show the current SSR 1 configuration To change the command source for channel 3 to dig type config 3 src dig enter Verify that the configuration has been changed using config 3 enter To save the modified configuration in on board non volatile memory so that it is pr
20. Erase Request Erase Configuration Description Erases the non volatile configuration memory Container Configuration Set Message Configuration ID Payload Length Direction 0x03 1 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK INV LEN SLERJ 5 3 4 Set Channel Parameter 5 3 4 1 Line Request Set Line Description Sets all communication parameters of a channel Container Configuration Set Message Configuration ID Payload Length Direction 0x10 5 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 Ul CID Configuration ID 1 U1 channel Channel 1 3 2 Ul line Line Parameters bits 7 6 parity 0 none 1 odd 2 even bits 5 4 stop bits 0 1 stop bit 1 1 5 stop bits 2 2 stop bits bits 3 0 reserved 3 U2 baud baud 100 Baud rate divided by 100 Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK INV LEN NACK INV CH NACK INV BAUD NACK INV PARITY NACK INV STOP SLERJ
21. K INV LEN SLERJ 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 The payload of these messages is passed to a configuration subsystem that handles the specific configuration request identified by the message payload Configuration subsystem operations are available to load save and erase the non volatile configuration memory set channel parameters and query current channel parameters As with general messages the SSR 1 replies to all configuration messages with acknowledgement ACK negative acknowledgement NACK or the requested data ACK messages are returned in response to successful Configuration Set ID 0x50 requests Header Payload Checksum Start Start2 ID Count Payload Cksum1 Cksum2 Ox81 OxAl 0x90 0x01 0x50 OxEI 0x02 NACK messages can be provided in response to Configuration Set or Configuration Query messages and will have the form Header Payload Checksum Start Start2 ID Count Payload Cksuml Cksum2 0x81 OxAl Ox91 0x02 0x50 OxEC OxCl OxC2 lt Config Set NACK 0x81 OxAl 0x91 0x02 0x51 OxEC OxCl
22. NV STOP Request Set Stop Description Sets stop bits for a channel Container Configuration Set Message Configuration ID Payload Length Direction 0x13 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 UI stop Stop bits 7 2 reserved bits 1 0 stop bits 0 1 stop bit 1 1 5 stop bits 2 2 stop bits Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK SLERJ 5 3 4 5 Function Request Set Function Description Sets a channel s function Container Configuration Set Message Configuration ID Payload Length Direction 0x20 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 function Function bits 7 2 reserved bits 1 0 function 0 disabled record 2 control 3 shell Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK_INV_LEN NACK_INV_CH NACK_SHCTRL_TAKEN SLERJ 5 3 4 6 Source Request Set Source Description S
23. Path Template Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number 4 See Section 3 2 Record Function for details on path templates SLERJ 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 out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 size File Size bits 7 4 reserved bits 3 0 file size 0 off 1 1MB 2 2 MB 3 4 MB 4 8 MB 5 16MB 6 32 MB 7 64 MB 8 128 MB 9 256 MB 10 512 MB 11 2 1024 MB 12 hour 13 day 14 week 15 not used Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ 5 4 Error Codes The control protocol provides a unified set of error codes t
24. SLERJ SSR 1 User s Manual Revision D 18 May 2015 SLERJ CONTENTS M o ERREUR 4 LI ceni RR m T T C 4 LI A dm aM E A 4 2 Getting Started Uo EAE EERS 4 2d Packase Contents c 4 22 TheSSR HardWare as a aeiiaaie a du 5 2 3 Eounec ng the SSR Lu eie reta Vosges ik pun a Seba E PR INDE MU pe ERR Bi 7 24 Using the SSR 9 a Functional Cere Wo ie e nein Ea EEEE O E E E TR Md 10 3d Serial etin TOU rantas en E EEA EERE S EEEE AN iai 10 3 22 Record Function esseeri enar mS 10 3 3 User Interface Modus 21sscccdepeteadidiscetis sasntendsainabactucundedeathesaaaesdancd saunaieevaseacadaagadaenaneeces 13 34A Reak ime Mte di Tm 13 35 Digital VO mc 13 4 Interactive SIE on a E E A E DE EM 14 Zl System Commands ae e a a a 15 42 File Commands Sorset ii EE EE E E E E ena 15 SEMESTER d 16 44 Capturing the SBell a ote doit ab epee uem b EN IM E MM M M IUE 17 5 Control Protocol sirier e A a 18 AME co duco antes 18 5 2 General Messages c ostio o e pend DU M tmu M ee 19 5 3 Configuration Messages a este Ru i ta EU MES 20 Deb JBERGEC OUDS adit a a 51 tr Ie Tagged ATCDIVES centre ia da 32 NEM CET c R 52 6 2 Time Correlation Packets ocne a 53 63 TheSTIPUUIIY E 53 FEE nli no m e a 55 f cuoc recipe 55 PEE uou iwa 56 MEM a
25. ayload Possible Replies ACK NACK INV LEN NACK INV CH SLERJ 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 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 UI type File Type bits 7 1 reserved bit 0 file type O raw 1 time tagged Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK INV LEN NACK INV CH SLERJ 5 3 4 9 File Mode NACK INV LEN NACK INV CH NACK INV FM 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 in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 UI mode File Mode bits 7 2 reserved bits 1 0 file mode 0 retry 1 append 2 overwrite Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2
26. card not present or not initialized 20 NACK SD INV DRIVE not currently used 21 NACK SD NOT ENABLED not currently used 22 NACK SD NO FS No file system was found on the card 23 NACK SD TIMEOUT A timeout occurred when accessing the card 24 NACK SD UNKNOWN Unknown file system or card error 25 NACK UNKNOWN The request was not recognized SLERJ 6 Time Tagged Archives Often it is important to know not only what serial data was transferred but when it was transferred This is useful in both the analysis of communication systems and in the ability to reconstruct streams as they originally occurred The SSR 1 supports time tagged archives in which received bytes are tagged with the time they were received When a channel is configured to record time tagged archives the received bytes are encapsulated in packets prior to being written to the file system Two types of packets are currently defined the data packet and a time correlation packet 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 6 1 Data Packet The data packet uses the system free running clock as the time stamp source Bytes are grouped into 2ms windows for stamping Each data packet begins with a base time stamp that identifies the whole second in which the data was
27. d in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ 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 out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 UI stop Stop bits 7 2 reserved bits 1 0 stop bits 0 1 stop bit 1 1 5 stop bits 2 2 stop bits Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ 5 3 5 5 Function Item Function Description Provides a channel s function Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x20 3 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel
28. dole 57 SLERJ 2015 Slerj LLC All rights reserved Reproduction in whole or in part is prohibited without the prior written consent of the copyright owner The information presented in this document does not form part of any quotation or contract is believed to be accurate and reliable and may be changed without notice No liability will be accepted by the publisher for any consequence of its use 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 resulting from misuse neglect improper installation repair improper handling or unusual physical or electrical stress including but not limited to exposure to parameters beyond the specified maximum ratings or operation outside the specified range All brands and product names in this publication are registered trademarks or trademarks of their respective holders Slerj is a trademark of Slerj LLC Warranty The SSR 1 Serial Data Recorder is warranted against defects in materials and manufacturing for a period of one year from the date of purchase In the event of a product failure due to materials or workmanship Slerj will at its discretion repair or replace the product For warranty service return the defective produce to Slerj shipping prepaid for prompt repair
29. e Format Header Payload Checksum Start Start2 ID Count Payload Cksum1 Cksum2 0x81 OxAl OxID OxNN OxAA OxBB OxC1 0xC2 OxZZ The start sequence for every packet is the same 0x81 OxA1 and is followed by a single ID character Count identifies the number of payload bytes that are included in the packet and can be zero The checksum bytes represent a Fletcher checksum as defined in internet RFC 1145 It is computed over the ID Count and payload bytes The basic algorithm for computing the checksum is unsigned char Cksuml 9 unsigned char Cksum2 0 unsigned char p address of message ID int i 0 while i number of payload bvtes 42 Cksum1 Cksum1 p i Cksum2 Cksum2 Cksum1 i i 1 Ordinarily have a single byte to represent payload count would suggest that the maximum possible payload length is 255 bytes But since many applications may require longer packets the most significant bit MSb of the Count is given special significance in the control protocol When the MSb is set the lower 7 bits are interpreted as a count of 8 byte blocks Also since counts without the MSb set already provide coverage for payloads between 0 and 127 bytes this special function starts at 128 bytes When the MSb of Count is set payload length is calculated as 128 Count amp 0x7F 8 SLERJ For example a Count of 0x80 would indicate a payload of 128 bytes A Count of 0x81 w
30. e following table are entered as part of a command line config lt ch gt commana Table 8 Channel Configuration Commands Command Alias Description baud rate Sets baud to rate 600 to 115200 parity EIOINIeloln Sets paritv to even odd or none stop 111 512 Sets the number of stop bits echo lt bool gt Enables echoing of received characters on the channel function record disabled shell func Sets the configured function for the channel control Note that the active function for a channel may be different from the configured function see Section 4 4 Capturing the Shell source Jf soft dig pwm src Sets the channel command source soft lt bool gt Sets the channel soft command file type raw tt Selects between raw and time tagged archives for the channel file mode retry append overwrite Sets the channel file mode file path lt path gt Sets the channel file path template to path See Section 3 2 Record Function for more information on path templates SLERJ Command Alias Description file size offI 1121418116132164 Sets the file size threshold See Section 3 2 128 256 512 1024 hour Record Function for more information on file day week size thresholds bool denotes a Boolean expression and may be specified using Cy IY ItiTItruel yeslon for affirmati
31. ed Payload Byte Type Notes Name Units Purpose Comment Offset yp p 0 U4 size kB Size of the disk 4 U4 free kB Unused disk space Notes 1 This message is polled by sending a message with ID 0x22 and no payload SLERJ 5 2 6 All Channel Status Message All Channel Status Description Provides the status of all channels ID Payload Length Direction Message Rate 0x24 3 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 2 channel1 bitfield Status bit 7 record is commanded bit 6 reserved bits 5 4 channel function 0 disabled 2 record 2 control 3 shell bits 3 0 channel file state 0 closed 1 building path 2 opening file 3 recording 4 path template translation error 5 error building path 6 error opening file 7 disk error 8 disk full 1 U1 channel2 bitfield see channel 1 2 U1 channel3 bitfield see channel 1 Notes 1 This message is polled by sending a message with ID 0x24 and no payload 2 File state 8 disk full was added in firmware 1 0 3 SLERJ 5 2 7 SetDate Message Set Date Description Sets the date ID Payload Length Direction Message Rate 0x30 4 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset yp p 0 U2 year Year 2001 2099
32. ed by File Path does not exist it is created File Path The File Path parameter holds a path template that specifies the name and location of the file to be created when recording is commanded A path template is a normal path string that has replaceable fields defined in Table 2 below A field is identified in the template by a backslash followed by one of the field identifiers or several consecutive identifiers encapsulated in square brackets For example the path template c chms dat would be SLERJ translated to the path c1083000 dat for channel 1 if the time is 08 30 00 when a file is created Similarly the path template gps nmeaM txt would be replaced by gps nmeaXXXX txt where XXXX is a number that is incremented on each attempt to open the file Currently path templates of up to 29 bytes are supported and the resulting path with fields replaced must be no more than 64 bytes Table 2 Path Template Field Codes Field Replaced With Identifier channel number 1 3 year 00 99 month 01 12 day 01 31 hour 00 23 minute 00 59 second 00 59 tenth of second 0 9 year 4 digit 2001 2099 hex digit month 1 C day of year 001 366 two digit sequence number 00 99 three digit sequence number 000 999 Alola fe 12 8 lolol Z S four digit sequence number 0000 9999 This field identifier is lower case File Size Startin
33. eserved across power cycles type config save enter To confirm that the configuration has been saved reboot the SSR 1 and verify configuration using reset enter config enter Note that cfg is an alias for config and can be used as a shortcut SLERJ 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 The behavior of each serial channel is independent and is defined by a number of configurable parameters e Baud rate 600 to 115200 baud inclusive e Parity Even odd or none e Stop l 1 5 or 2 stop bits e Echo Boolean Echoes received characters out through the transmitter e Function o disabled The channel is not used o record The channel will record received data when commanded o shell The channel will be tied to the interactive user shell function of the user interface module o control The channel will be tied to the control protocol function of the user interface module Note that the user interface module can be attached only to a single channel If one of the channels is assigned to either the SHELL or CONTROL functions no other channel may be assigned to SHELL or CONTROL 3 2 Record Function In addition to the basic serial channel parameters above when a channel is assigned to the RECORD functi
34. estamp on a file or directory SLERJ 4 3 Device Configuration Device configuration is manipulated through the user interface module The current working configuration is held in system memory 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 Configuration Commands Command Description config Prints the current configuration including all channels config save Saves the working configuration to non volatile memory config load Retrieves the stored configuration from non volatile memory config erase Erases the non volatile configuration memory but does not change the current working configuration When non volatile configuration memory has been erased configuration defaults are loaded at startup config lt ch gt args Provides access to channel configuration The parameter ch is the channel number 1 to 3 If no additional arguments are specified this command prints the configuration for the specified channel Specific channel configuration commands are in Table 8 In addition to the global configuration commands presented in Table 7 there are several channel specific configuration commands The commands in th
35. ets a channel s record command source Container Configuration Set Message Configuration ID Payload Length Direction 0x21 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 source Source bits 7 3 reserved bits 2 0 source 0 soft soft command true on reset 1 soft soft command false on reset 2 dig DI pin record when high 3 dig DI pin record when low 4 pwm PI pin record when 2ms 5 pwm PI pin record win 1ms Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message payload Possible Replies ACK NACK_INV_LEN NACK_INV_CH NACK_INV_SOURCE SLERJ 5 3 4 7 Soft Command Request Set Soft Command Description Sets the value of a channel s internal soft command Container Configuration Set Message Configuration ID Payload Length Direction 0x22 3 bytes in Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 soft Soft Command bits 7 1 reserved bit 0 soft command 0 false 1 true Notes 1 Configuration ID is the first byte of the payload in the Configuration Set or Query container message 2 Payload length is the length of the container message p
36. g 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 Additionally the File Size parameter can be set to Hour Day or Week causing new files to be started based on time instead of size By default the File Size threshold is off and no automatic close reopen operations are performed SLERJ 3 3 User Interface Module The user interface module provides user access to file system operations device status and configuration The module can be assigned to only one serial channel and can be configured to present either an interactive shell interface or the control protocol on that channel More information on the interactive shell and control protocol can be found in Sections 4 and 5 respectively 3 4 Real Time Clock The Real Time Clock RTC maintains calendar time for the SSR 1 An on board backup battery CR1220 or CR1216 Lithium 3V allows the RTC to keep time across power cycles The RTC time is used to provide time stamps for the creation of files and is associated with the free running system clock in time tagged archives 3 5 Digital I O Digital input and output lines are provided for hardware access to recording control and status On the main connector PI and DI provide record control as discussed in Section 3 2 Additionally a status line is prov
37. he current date to the year month and day specified If no date is specified this command returns the current date help l Provides help for using the shell reset Performs a device reset status stat Displavs device status date time inputs record channels time Sets the current time using the hour minute and second specified hhmmss ap The hour is assumed to be in 24 hour format However the time may be appended with an a or p to explicitly identify AM or PM if a 12 hour format is used 4 2 File Commands File commands provide access to the SD card file system FAT12 FAT16 and FAT32 volumes are supported and long filenames are supported on FAT32 Many file system commands require a path Both relative and absolute paths are supported in the shell Directories are separated by a forward slash Table 6 File Commands Command Aliases Description chdir path cd Changes the current working directory del path rm Removes a file or an empty directory df Prints the volume size and free space dir path Is Lists the contents of a directory If no path is provided this command lists the contents of the current directory mkdir path md Creates a directory pwd Prints the current working directory ren lt pathI gt lt path2 gt mv rn Moves or renames a file or directory from path to path2 NOTE Do not move open files touch path Updates the tim
38. ided for each channel S1 S2 and S3 to indicate when the channel is recording Finally a bi color red and green status LED is provided on the SSR 1 for each channel Figure 1 The red segment illuminates when the corresponding channel is recording The green segment flashes to indicate reception of serial data on the channel In firmware 1 0 3 flash codes were added to make status of the SSR 1 plainly visible The following flash codes are implemented using the red LEDs Table 3 LED Flash Patterns Status Flash Pattern Description READY Indicates that a record channel is ready to Short flash every 4 seconds record when commanded CARD ERROR 8 u Indicates that the card is missing or an Long flash followed by two short unrecoverable error has occurred flashes every 2 seconds CARD FULL Indicates that the card is full Two long flashes every 2 seconds Presented only on channels configured to record Presented on all channel LEDs simultaneously SLERJ 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 Each command can be followed by to retrieve help information Multiple commands can be separated by a semi colon All commands are case sensitive For example cls Usage
39. length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ 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 out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U1 mode File Mode bits 7 2 reserved bits 1 0 file mode 0 retry append 2 overwrite Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number 5 3 5 10File Path Item File Path Description Provides the path template used by a channel when recording Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x33 3 to 31 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 CID Configuration ID 1 U1 channel Channel 1 3 2 BN 4 path File
40. length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number SLERJ 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 out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 UI CID Configuration ID 1 U1 channel Channel 1 3 2 U2 baud baud 100 Baud rate divided by 100 Notes 1 Configuration ID is the first byte of the payload in the Configuration Query Reply container message 2 Payload length is the length of the container message payload 3 This message is polled using a Configuration Query message with a two byte payload this Configuration ID and the channel number 5 3 5 3 Parity Item Parity Description Provides parity for a channel Container Configuration Query Reply Message Configuration ID Payload Length Direction Message Rate 0x12 3 bytes out polled Payload Byte Type Notes Name Units Purpose Comment Offset 0 U1 CID Configuration ID 1 Ul channel Channel 1 3 2 UI parity Parity bits 7 2 reserved bits 1 0 parity 0 none 1 odd 2 even Notes 1 Configuration ID is the first byte of the payloa
41. n in slot beneath board MicroSD Card Slot push push tvpe connector Coin Batterv Holder This is the negative side of the batterv It must make contact with the printed circuit board D WWW Sler com t J SSR 1 User s Manual SLERJ Rev D 18 May 2015 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 CAUTION Like most electronic components the SSR 1 can be damaged by A electrostatic discharge Observe typical precautions for handling electrostatic discharge sensitive devices 2015 Slerj LLC 6 www slerj com SLERJ 2 3 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 All channels default to 115200 baud 8 data bits no parity and stop bit A WARNING Channels 1 and 2 are RS 232 voltage level compatible and channel 3 is 5 Volt tolerant TTL compatible 3 3V CMOS Do not connect an RS 232 device to channel 3 of the SSR 1 pu 0 res PI DI GND T3 GN 19 17 15 13 11 9 20 18 16 14 12 10 S3 S2 S1 GN
42. o simplify interpreting and displaying errors to the user The possible error codes are listed in Table 12 Table 12 Control Protocol Error Codes Value Name Description 1 NACK INV LEN The message does not have the expected length 2 NACK INV CH An invalid channel number was provided Must be 1 to 3 3 NACK INV NV The non volatile configuration memory contents are invalid 4 NACK INV DATE The date is invalid 5 NACK INV TIME The time is invalid 6 NACK INV BAUD The baud rate is invalid outside min max allowed 7 NACK INV PARITY The parity is invalid 8 NACK INV STOP The stop bit value is invalid 9 NACK SHCTRL TAKEN The shell or control function is already assigned to another channel It cannot be assigned to more than one channel 10 NACK INV SOURCE The record command source is invalid 11 NACK INV FM The file mode is invalid 12 NACK PATH LEN The path template is too long 13 NACK PATH SYNTAX The path has a syntax error 14 NACK PATH INV TOKEN The path has an unrecognized template field code 15 NACK PATH SEQ A sequence field code was used in a directory name and is only valid in a file name 16 NACK PATH XLEN The translated path is too long after replacing all field codes 17 NACK SD DISK ERR File system disk error 18 NACK SD INT ERR File system internal error 19 NACK SD NOT READY The file system is not ready
43. on several other configurable parameters apply e Command Source Command Source determines how the channel is commanded to record Options include a discrete digital signal a PWM signal or software controlled through the user interface module shell or control protocol Command Source for a channel can be set to one of the following o soft The channel records when the Soft Command parameter defined in the next major bullet is true With soft the default for Soft Command at startup is false The DI and PI pins are ignored o soft The channel records when the Soft Command parameter is true With soft the default for Soft Command at startup is true This selection for Command Source causes the channel to automatically record at startup The DI and PI pins are ignored o dig The channel records when the digital input pin DI is low o dig The channel records when the digital input pin DI is high SLERJ o pwm Recording starts when the pulse width on the pulse input pin PI is Ims 250us Recording stops when the pulse width on PI is 2ms 250us o pwm Recording starts when the pulse width on the pulse input pin PI is 2ms 250us Recording stops when the pulse width on PI is 1ms 250us The PWM input is designed to work with the type of signal used by hobby servos The signal is considered valid when high going pulses are present with a pulse width between 750us and 2250us and a period of 4ms to 65m
44. or replacement Slerj its suppliers and its licensors shall in no event be liable for any damages arising from the use of or inability to use this product This includes business interruption loss of business information or other loss which may arise from the use of this product SLERJ PRODUCTS ARE NOT DESIGNED INTENDED AUTHORIZED OR WARRANTED TO BE SUITABLE FOR USE IN LIFE SUPPORT APPLICATIONS DEVICES OR SYSTEMS OR OTHER CRITICAL APPLICATIONS INCLUSION OF SLERJ PRODUCTS IN SUCH APPLICATIONS IS UNDERSTOOD TO BE UNDERTAKEN SOLELY AT THE CUSTOMER S OWN RISK Should a customer purchase or use Slerj products for any such unauthorized application the customer shall indemnify and hold Slerj and its officers employees subsidiaries affiliates and distributors harmless against all claims costs damages and attorney fees which could arise SLERJ 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 can be recorded simultaneously in either a raw format or in a time tagged archive to allow analysis and reconstruction of serial streams Streams can be recorded automatically at power up on command through a digital or PWM input or using software commands 1 2 Features Simultaneously records three asynchronous serial channels Two RS 232 channels and one 5V TTL compatible channel Version
45. ould indicate a payload length of 136 bytes The longest payload supported by this implementation is Count OxFF 1144 bytes When the MSb of count is set the payload length will be modulo 8 In the control protocol all multi byte values are sent most significant byte first 1 e big endian In this document messages are divided into two groups general messages and messages used to set and query configuration In the message definitions types will be identified by the following abbreviations shown in Table 10 Table 10 Control Protocol Type Definitions Type Description Ul Unsigned 8 bit integer U2 Unsigned 16 bit integer U4 Unsigned 32 bit integer Il Signed 8 bit integer D Signed 16 bit integer I4 Signed 32 bit integer Bx String of x bytes BN 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 Table 11 General Control Protocol Messages ID Direction Description 0x10 in Record 0x11 in Stop 0x20 out Command Status 0x21 out Card Status 0x22 out Disk Status 0x24 out All Channel Status 0x30 in Set Date 0x30 out Date 0x31 in Set Time 0x31 out Time 0x50 in Configuration Set
46. re 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 The active function will mirror the configured function when possible Once the shell becomes the active function on a channel the channel parameters that affect communication baud parity stop and active function are fixed until reset Any channel configuration options changed for the captured channel and saved will not take effect until the next reset If the shell was the configured function on a channel other than the captured channel the active function for that channel becomes disabled SLERJ 5 Control Protocol In place of the interactive shell the user interface module can provide access to control status and configuration through a control protocol This capability is provided to support robust communication in machine automation environments The notation used in this section is intended to be familiar to C programmers Values presented in hexadecimal are prepended with Ox The amp 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 Table 9 Control Protocol Messag
47. s The current record state for a channel using the PWM input is changed only when a valid PWM signal is present that meets the requirements of the selected PWM Command Source pwm or pwm specified above Both the DI and PI pins are 5 volt tolerant and internally pulled to 3 3V See Section 7 1 Electrical for specifications Soft Command Soft Command is a Boolean software parameter that determines whether the channel records when the Command Source parameter is soft The Soft Command parameter can be set through the user interface module interactive shell or control protocol File Type The SSR 1 supports both raw and time tagged archives When file type is raw bytes are written to file just as they are received When file type is tt bytes are encapsulated into a file structure that associates a timestamp with received bytes Bytes are stamped with a resolution of 2ms For details see Section 6 Time Tagged Archives File Mode 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 Overwrite will cause an existing file to be replaced by anewly commanded recording Append will cause new data to be appended to an existing file For both overwrite and append modes if the file specifi
48. v 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 Clarified the description of command sources in 3 2 Record Function Clarified the control protocol description in 5 Control Protocol Corrected the truncated missing text in the description of the control protocol Count field in 5 1 Message Format Corrected the footnote in the Query Channel Parameter message tables in Section 5 3 5 regarding how to poll each message Corrected the description of Run Time in Table 14 Time Tagged Time Correlation Packet The Run Time value in this packet is in milliseconds not seconds Separated digital input and output in Section 7 1 Electrical to clarify specifications and provide more details Removed shading from tables to prevent problems with PDF generation Other minor typographical and clarification edits 26 March 2014 Updated document date revision markings and table of content for new sections Documentation added for firmware 1 0 3 Added File Size threshold Section 3 2 Record Function Added Flash Codes in Section 3 5 Digital I O Added file size command in Table 8 Channel Configuration Commands Added disk full channel file state to 5 2 6 All Channel Status message Added File Size set query messages 5 3 4 11 and 5 3 5 11 5 May 2014 Updated photos to match Rev
49. ve and nINIfIFIfalse noloff for negative The prefix is optional If not specified is assumed Note that multiple channel configuration commands may be specified together For example to set the baud parity and stop parameters of channel 2 with a single command type config 2 baud 38400 parity N stop 1 4 4 Capturing the Shell To allow all channels to be used for recording without precluding use of the shell for configuration the shell can be captured by the user on startup on any channel The design of this feature is a compromise between conflicting requirements Normal startups should be fast and the shell should prevent accidental capture The capture mechanism operates prior to loading stored configuration data so all channels operate at 115200 baud 8 bits no parity and 1 stop bit for capture The process for capture is as follows e On startup the SSR 1 displays the boot loader message and device information e The user optionally sends up to 5 lower case z characters followed by the string config All bytes in this sequence are echoed to the user If any byte is received that is not part of this sequence or more than 800ms passes between bytes the capture process is terminated and the SSR 1 starts normally e When the previous step has been completed the SSR 1 will send a random challenge string consisting of 4 upper case characters The user must type those same characters in lower case to complete the captu
50. vel output voltage 8mA 2 9 V Low level output voltage 20mA 1 3 V High level output voltage 420mA 2 0 V RS 232 Transmitter Characteristics Channels 1 and 2 Transmitter Output Voltage Range 13 2 13 2 V Transmitter Output Voltage into 3kQ Load 5 V RS 232 Receiver Characteristics Channels 1 and 2 Receiver Input Voltage Range 25 25 V Positive going input threshold voltage 1 5 2 4 V Negative going input threshold voltage 0 6 1 2 V SanDisk 4GB Class 4 microSDHC card inserted but no data being received SanDisk 4GB Class 4 microSDHC card inserted recording three full streams at 115200 baud SSR 1 User s Manual SLERJ Rev D 18 May 2015 7 2 Mechanical 39 37mm D4 57mm 1 550 0 180 4 06mm 32 51mm D2 44mm 0 160 1 280 0 096 41 16mm Hi 0 046 no 25 91mm n 1 240 roo E BA LH 12 36mm 0 487 2 79mm 3 30mm eject stroke 0 110 0 130 r 0 90mm overstroke 0 035 6 30mm 0 248 200mm 0 079 1 59mm l 0 063 m m V V B je l Co tel 3 00mm Apa 0 118 0 122 1 78mm 4 06mm 0 070 0 160 11 05mm 0 435 2 00mm 0 079 2 00mm 0 079 4 06 13 21 E 0 160 0520 i Mounting holes designed for 2 hardware Main Connector Molex 87833 2020 Mating Connector Molex 87568 2093 Battery CR1220 or CR1216 3V button cell 2015 Slerj LLC 56 www slerj com SLERJ 8 Revision History Date Re
Download Pdf Manuals
Related Search