HMS IXXAT simplyCAN, User Manual

Page 1: ...s siim mp plly yC CA AN N U US SB B t to o C CA AN N A Ad da ap pt te er r USER MANUAL 4 01 0001 22001 1 0 en US ENGLISH ...

Page 2: ...lations codes and standards HMS Industrial Networks will under no circumstances assume liability or responsibility for any problems that may arise as a result from the use of undocumented features timing or functional side effects found outside the documented scope of this product The effects caused by any direct or indirect use of such aspects of the product are undefined and may include e g comp...

Page 3: ...ons 5 2 1 Information on EMC 5 2 2 General Safety Instructions 5 2 3 Intended Use 5 3 Scope of Delivery 5 4 Product Description 6 5 Installation 7 6 Operation 8 6 1 simplyCAN Bus Monitor 8 6 2 USB LED 9 6 3 CAN LED 9 7 Additional Components 10 7 1 CAN Bus Termination 10 8 Technical Data 11 9 Troubleshooting 11 10 Cleaning 12 11 Support Return Hardware 12 11 1 Support 12 11 2 Return Hardware 12 ...

Page 4: ...y_initialize_can 13 13 1 4 simply_identify 14 13 1 5 simply_start_can 14 13 1 6 simply_stop_can 15 13 1 7 simply_reset_can 15 13 1 8 simply_can_status 16 13 1 9 simply_set_filter 17 13 1 10 simply_receive 18 13 1 11 simply_send 18 13 1 12 simply_get_last_error 19 13 2 State Diagram 20 A Regulatory Compliance 21 A 1 EMC Compliance CE 21 A 2 Disposal and recycling 21 ...

Page 5: ...plicable standards The contents of the manual must be made available to any person authorized to use or operate the product 1 2 Document History Version Date Description 1 0 March 2019 First release 1 3 Trademark Information Ixxat is a registered trademark of HMS Industrial Networks AB All other trademarks mentioned in this document are the property of their respective holders simplyCAN User Manua...

Page 6: ... 4 This is an external link URL www hms networks com Safety advice is structured as follows Cause of the hazard Consequences of not taking remediate action How to avoid the hazard Safety signs and signalwords are used dependent on the level of the hazard This is additional information which may facilitate installation and or operation This instruction must be followed to avoid a risk of reduced fu...

Page 7: ...roduct from fire Do not paint the product Do not modify or disassemble the product Service must be carried out by HMS Industrial Networks Store products in dry and dust free place 2 3 Intended Use The device is used to connect computer systems to CAN networks to exchange data for example to configure a device via CAN or to read device diagnosis data The simplyCAN is intended for the connection to ...

Page 8: ...ing interface Features USB 1 1 Full Speed 12 MBit s 1 x CAN high speed channel according to ISO 11898 2 D Sub 9 fieldbus connection pin allocation according to CiA 303 1 USB cable with plug type A Windows the simplyCAN is tested on Windows 7 32 bit and 64 bit and Windows 10 64 bit Linux the simplyCAN is tested using Ubuntu 14 04 on Linux kernel version 4 4 as well as Ubuntu 18 04 on Linux kernel v...

Page 9: ...lugged in To show the simplyCAN as Ixxat simplyCAN COMx in the device manager execute the file setup bat also on Windows 10 Plug the USB connector in the USB port of computer Hardware is automatically found and installed USB LED is green flashing If necessary install a bus termination see CAN Bus Termination p 10 Connect the CAN fieldbus connector to the CAN fieldbus Start the simplyCAN bus monito...

Page 10: ... button Disconnect 3 select the device in drop down list Select device 1 and click button Connect 2 Select the desired CiA baudrate 5 To start the communication click button CAN start 6 CAN messages are shown in the window Output 8 In transmitted messages the time stamp is 0 and the flag S is displayed To send a message enter the message in the Transmit line 9 see Transmit Messages p 9 for more in...

Page 11: ...ith ID 1FE1200 hex and 8 data bytes 123 R 8 11 bit remote frame with ID 123 and DLC 8 0x1FE1200 R 8 29 bit remote frame with ID 1FE1200 hex and DLC 8 6 2 USB LED The USB LED reflects the status of the USB communication LED state Description Comments Off Power off No power or device defect Green flashing No active connection Device ready to use simplyCAN bus monitor or API must be started to use th...

Page 12: ...is no bus termination resistor for the CAN bus integrated in the device HMS Industrial Networks offers a bus termination resistor as a feed through connector Fig 2 CAN bus termination resistor For ordering information see www ixxat com simplyCAN User Manual 4 01 0001 22001 1 0 en US ...

Page 13: ...erature 20 to 70 C Storage temperature 40 to 85 C Relative humidity 10 to 95 non condensing Housing material ABS plastic Protection class IP40 9 Troubleshooting USB LED is off after connecting No power or defect device Make sure that the device is correctly connected to the USB port Connect the device directly to the computer or to self powered hubs Extension cable is used and device is not workin...

Page 14: ...t support at www ixxat com support If required use support phone contacts on www ixxat com 11 2 Return Hardware Fill in the form for warranty claims and repair on www ixxat com Print out the Product Return Number PRN resp RMA Pack product in a physically and ESD safe way use original packaging if possible Enclose PRN number Observe further notes on www ixxat com Return hardware 12 Disposal Dispose...

Page 15: ...he command ls l dev serial by id Return Value Return value Description true Function succeeded false Error occurred call simply_get_last_error for more information 13 1 2 simply_close Closes the serial communication interface and resets the CAN controller bool simply_close void Return Value Return value Description true Function succeeded false Error occurred call simply_get_last_error for more in...

Page 16: ...duct version string e g 1 00 00 uint8_t product_string 30 Zero terminated product string e g simplyCAN 1 0 uint8_t serial_number 9 Zero terminated serial number e g HW123456 identification_t Return Value Return value Description true Function succeeded false Error occurred call simply_get_last_error for more information 13 1 5 simply_start_can Starts the CAN controller Sets the CAN controller into...

Page 17: ...t_last_error for more information Remarks To ensure that all messages are transmitted before stopping the CAN controller read the CAN status until the CAN_STATUS_PENDING flag is no longer set 13 1 7 simply_reset_can Resets the CAN controller hardware reset and clears the message filter open for all message identifiers Sets the CAN controller into mode init bool simply_reset_can void Return Value R...

Page 18: ...definitions uint16_t tx_free number of free elements in CAN message tx fifo can_sts_t CAN Status Definitions CAN status definitions define CAN_STATUS_RUNNING 0x01 define CAN_STATUS_RESET 0x02 define CAN_STATUS_BUSOFF 0x04 define CAN_STATUS_ERRORSTATUS 0x08 define CAN_STATUS_RXOVERRUN 0x10 define CAN_STATUS_TXOVERRUN 0x20 define CAN_STATUS_PENDING 0x40 Return Value Return value Description true Fun...

Page 19: ...r the positions that are marked as relevant 1 in mask Values in positions that are marked as not relevant 0 in mask are ignored The following formula expresses the condition under which an identifier passes the filter if value mask identifier mask then identifier is valid Example 11 Bit Identifier hex bin Value 0x700 0111 0000 0000 Mask 0x700 0111 0000 0000 Result 0x700 0111 0000 0000 Any identifi...

Page 20: ... simply_send Writes a CAN message to the transmit FIFO To check if the message is transmitted request the CAN status with simply_can_status bool simply_send can_msg_t can_msg Parameter Parameter Dir Description can_msg in Pointer to a CAN message to be transmitted see CAN Message Structure Return Value Return value Description true Function succeeded false Error occurred call simply_get_last_error...

Page 21: ...OMM Serial communication error 5 SIMPLY_E_CMND_REQ_UNKNOWN Command unknown on device 6 SIMPLY_E_CMND_RESP_TIMEOUT Command response timeout reached 7 SIMPLY_E_CMND_RESP_UNEXPECTED Unexpected command response received 8 SIMPLY_E_CMND_RESP_ERROR Command response error 9 SIMPLY_E_INVALID_PROTOCOL_VERSION Invalid simplyCAN protocol version 10 SIMPLY_E_INVALID_FW_VERSION Invalid device firmware version ...

Page 22: ...ed simply_reset_can Device connected CAN initialized CAN running simply_start_can CAN initialized simply_stop_can Device connected CAN initialized CAN running simply_receive CAN initialized CAN running simply_send CAN running simply_get_last_error All states simply_can_status Device connected CAN initialized CAN running simply_identify Device connected CAN initialized CAN running simply_set_filter...

Page 23: ...ng You must dispose of this product properly according to local laws and regulations Because this product contains electronic components it must be disposed of separately from household waste When this product reaches its end of life contact local authorities to learn about disposal and recycling options or simply drop it off at your local HMS office or return it to HMS For more information see ww...

Page 24: ...last page 2019 HMS Industrial Networks Box 4126 300 04 Halmstad Sweden info hms se 4 01 0001 22001 1 0 en US 2019 02 21 11802 ...