Related Manuals for HMS IXXAT simplyCAN
Summary of Contents for HMS IXXAT simplyCAN
- Page 1 s s i i m m p p l l y y C C A A N N U U S S B B - - t t o o - - C C A A N N A A d d a a p p t t e e r r USER MANUAL 4.01.0001.22001 1.0 en-US ENGLISH...
- Page 2 Important User Information Liability Every care has been taken in the preparation of this document. Please inform HMS Industrial Networks of any inaccuracies or omissions. The data and illustrations found in this document are not binding. We, HMS Industrial Networks, reserve the right to modify our products in line with our policy of continuous product development. The information in this document is subject to change without notice and should not be considered as a commitment by HMS Industrial Networks.
-
Page 3: Table Of Contents
Table of Contents Page User Guide ........................... 3 Target Audience.......................3 Document History ......................3 Trademark Information .....................3 Conventions........................4 Safety Instructions ......................5 Information on EMC ......................5 General Safety Instructions ....................5 Intended Use........................5 Scope of Delivery ........................ 5 Product Description ......................6 Installation........................... - Page 4 12 Disposal..........................12 13 API Documentation ......................13 13.1 API Functions ........................ 13 13.1.1 simply_open ......................13 13.1.2 simply_close ......................13 13.1.3 simply_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 ....................
-
Page 5: User Guide
Version Date Description March 2019 First release 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. 4.01.0001.22001 1.0 en-US simplyCAN User Manual... -
Page 6: Conventions
This is a cross-reference within this document: Conventions, p. 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. -
Page 7: Safety Instructions
Protect product 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. 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. -
Page 8: Product Description
Product Description 6 (22) Product Description The simplyCAN is an active USB adapter which enables the user to connect a computer with a CAN network to monitor the network traffic and to interact with other network devices. The simplyCAN is a plug and play device due to the easy installation and the easy-to-use CAN programming interface. -
Page 9: Installation
On Windows 10 the COM interface for the simplyCAN is showed as USB Serial Device (COMx) in the device manager when plugged in. To show the simplyCAN as Ixxat simplyCAN (COMx) in the device manager, execute the file setup.bat also on Windows 10. -
Page 10: Operation
Operation 8 (22) Operation simplyCAN Bus Monitor Fig. 1 simplyCAN bus monitor Start the simplyCAN bus monitor. ► → If one simplyCAN is connected to the computer, the device is automatically selected and connected (1). If several simplyCAN are connected to the computer, select the desired device (1) and click ►... -
Page 11: Usb Led
Operation 9 (22) ► Clear the output window with button Clear (10). For a busload higher than 65 % data loss is possible. Data loss is signalled to the application by the Ovr LED in the simplyCAN bus monitor. Transmit Messages Syntax: <id>... -
Page 12: Additional Components
10 (22) Additional Components CAN Bus Termination There 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. -
Page 13: Technical Data
Technical Data 11 (22) Technical Data USB interface USB 1.1, Full-Speed (12 MBit/s) CAN bitrates 10 kbit/s to 1 Mbit/s, only CiA recommended bit rates are supported: 10, 20, 50, 125, 250, 500, 800, 1000 CAN transceiver TI SN65HVD251 None CAN bus termination Dimensions 80 x 50 x 22 mm... -
Page 14: Cleaning
Cleaning 12 (22) Cleaning Disconnect the device from power supply. ► Remove dirt with a soft, chemical untreated, dry cloth. ► Support/Return Hardware Observe the following information in the support area on www.ixxat.com: • information about products • FAQ lists •... -
Page 15: Api Documentation
API Documentation 13 (22) API Documentation 13.1 API Functions To show the use of the functions, examples in C, C# and Python are available on www.simplycan.info. 13.1.1 simply_open Opens the serial communication interface. The message filter of the CAN controller is opened for all message identifiers. -
Page 16: Simply_Identify
API Documentation 14 (22) 13.1.4 simply_identify Gets firmware and hardware information about the simplyCAN device. bool simply_identify(identification_t *p_identification); Parameter Parameter Dir. Description p_identification [out] Pointer to the identification structure Identification Structure typedef struct _identification { uint8_t fw_version[8]; // Zero terminated firmware version string e.g. "1.00.00" uint8_t hw_version[8];... -
Page 17: Simply_Stop_Can
API Documentation 15 (22) 13.1.6 simply_stop_can Stops the CAN controller. Sets the CAN controller into mode init. Does not reset the message filter of the CAN controller. Only stop the CAN controller when the CAN_STATUS_PENDING flag is not set. bool simply_stop_can(void); Return Value Return value Description... -
Page 18: Simply_Can_Status
API Documentation 16 (22) 13.1.8 simply_can_status Gets the status of the CAN controller. bool simply_can_status(can_sts_t *can_sts); Parameter Parameter Dir. Description can_sts [out] Status as bit coded 16 bit value (see CAN status structure) CAN Status Structure typedef struct _can_sts { uint16_t sts;... -
Page 19: Simply_Set_Filter
API Documentation 17 (22) 13.1.9 simply_set_filter Sets the 11 or 29 bit message filter of the CAN controller. To set the 29 bit message filter, the MSB in parameter value must be set. bool simply_set_filter(uint32_t mask, uint32_t value); Parameter Parameter Dir. -
Page 20: Simply_Receive
API Documentation 18 (22) 13.1.10 simply_receive Receives a single CAN message. int8_t simply_receive(can_msg_t *can_msg); Parameter Parameter Dir. Description can_msg [out] Pointer to the CAN message structure the received CAN message is copied to CAN Message Structure typedef struct _can_msg { uint32_t timestamp;... -
Page 21: Simply_Get_Last_Error
API Documentation 19 (22) 13.1.12 simply_get_last_error Gets the last error code. After reading the error code with simply_get_last_error the error code is set to 0. Each error can only be read once. int16_t simply_get_last_error(void); Return Value Error Return value Description No error occurred SIMPLY_S_NO_ERROR SIMPLY_E_SERIAL_OPEN... -
Page 22: State Diagram
API Documentation 20 (22) 13.2 State Diagram Fig. 3 SimplyCAN states Function Calls and the Corresponding Valid States Function Valid states Not connected simply_open() Device connected, simply_close() CAN initialized Device connected, simply_initialize_can() CAN initialized Device connected, simply_reset_can() CAN initialized, CAN running CAN initialized simply_start_can() Device connected,... -
Page 23: A Regulatory Compliance
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 www.hms-networks.com. - Page 24 © 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...
Need help?
Do you have a question about the IXXAT simplyCAN and is the answer not in the manual?
Questions and answers