Danfoss WS403x, WS503x Operating guide
User Manual
PLUS+1® GUIDE Software
WS403x/WS503x Function Block Library
powersolutions.danfoss.com
User Manual
WS403x/WS503x Function Block Library
Revision history |
Table of revisions |
|
|
|
|
|
|
|
Date |
Changed |
Rev |
|
|
|
|
|
May 2016 |
First edition |
0101 |
|
|
|
|
2 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual |
|
WS403x/WS503x Function Block Library |
|
Contents |
|
About this manual |
|
Organization and Headings.......................................................................................................................................................... |
5 |
Special Text Formatting................................................................................................................................................................. |
5 |
WS FW, WS Configurator and Default Configuration.......................................................................................................... |
5 |
Introduction |
|
Blocks Structure................................................................................................................................................................................ |
6 |
WS403x/WS503x Object................................................................................................................................................................ |
8 |
Object Access..................................................................................................................................................................................... |
8 |
Custom objects............................................................................................................................................................................... |
12 |
Device variables |
|
Parameter name: DevApp_MasterMode............................................................................................................................... |
14 |
Parameter name: DevCfg_VerStr............................................................................................................................................. |
14 |
Parameter name: OperationTmTot......................................................................................................................................... |
15 |
Parameter name: CAN1_NodeID.............................................................................................................................................. |
15 |
Parameter name: CAN1_Baud_Rate....................................................................................................................................... |
15 |
Parameter name: Dis_En_Objs.................................................................................................................................................. |
16 |
Parameter name: RemoteSafetyFncAct................................................................................................................................. |
16 |
Accelerometer |
|
Parameter name: Lateral............................................................................................................................................................. |
18 |
Parameter name: Longitudinal................................................................................................................................................. |
18 |
Parameter name: Vertical............................................................................................................................................................ |
19 |
Remote Safety Mechanism |
|
Parameter name: State................................................................................................................................................................. |
20 |
Parameter name: State_CAN..................................................................................................................................................... |
21 |
Parameter name: State_Internal............................................................................................................................................... |
21 |
Parameter name: State_Combo............................................................................................................................................... |
21 |
Local Geofence |
|
Parameter name: Mode............................................................................................................................................................... |
22 |
Parameter name: Coord1_Long............................................................................................................................................... |
22 |
Parameter name: Coord1_Lat................................................................................................................................................... |
23 |
Parameter name: Coord2_LongRad........................................................................................................................................ |
23 |
Parameter name: Coord2_Lat................................................................................................................................................... |
24 |
Parameter name: Status_Chg_UTC ........................................................................................................................................ |
24 |
Parameter name: Status............................................................................................................................................................... |
25 |
Logging |
|
Parameter name: SendFileCmd................................................................................................................................................ |
26 |
Parameter name: En_SD_CardLog.......................................................................................................................................... |
26 |
Parameter name: FileHeaderText............................................................................................................................................. |
26 |
Parameter name: FileUploadPeriod........................................................................................................................................ |
27 |
Mobile |
|
Parameter name: AntennaStatus ............................................................................................................................................ |
28 |
Parameter name: Network_State............................................................................................................................................. |
28 |
Parameter name: Modem_Result............................................................................................................................................. |
29 |
Parameter name: Signal_Quality.............................................................................................................................................. |
29 |
Parameter name: Net_Mode_Select....................................................................................................................................... |
29 |
Parameter name: Net_Mode_Cur............................................................................................................................................ |
30 |
Parameter name: ActNetProvider............................................................................................................................................ |
30 |
Parameter name: SIM_IMSI......................................................................................................................................................... |
31 |
Parameter name: SIM_ICCID...................................................................................................................................................... |
31 |
Parameter name: SIM_PIN_ErrFlg............................................................................................................................................ |
31 |
Parameter name: StateMachErrCode..................................................................................................................................... |
32 |
Parameter name: CMS_ErrNum................................................................................................................................................ |
32 |
Parameter name: CME_ErrNum................................................................................................................................................ |
32 |
Parameter name: Serv_ReconnectTm.................................................................................................................................... |
33 |
Parameter name: Eng_IMEI_Num............................................................................................................................................ |
33 |
© Danfoss | May 2016 |
AQ00000215en-US0101 | 3 |
User Manual |
|
WS403x/WS503x Function Block Library |
|
Contents |
|
Parameter name: Eng_Identity................................................................................................................................................. |
33 |
Parameter name: Eng_Version.................................................................................................................................................. |
34 |
Positioning |
|
Parameter name: Longitude ..................................................................................................................................................... |
35 |
Parameter name: Latitude.......................................................................................................................................................... |
35 |
Parameter name: SpeedOvrGnd............................................................................................................................................... |
36 |
Parameter name: Heading.......................................................................................................................................................... |
36 |
Parameter name: GPS _Odometer........................................................................................................................................... |
36 |
Parameter name: DataValid........................................................................................................................................................ |
37 |
Parameter name: AntennaStatus ............................................................................................................................................ |
37 |
Parameter name: ActiveSatellites............................................................................................................................................ |
38 |
Parameter name: Mode_GNSS.................................................................................................................................................. |
38 |
Parameter name: EngineVersion.............................................................................................................................................. |
38 |
Security Variables |
|
Parameter name: RemoteAccessPass..................................................................................................................................... |
39 |
Parameter name: SIM_PIN.......................................................................................................................................................... |
39 |
Parameter name: UMTS_RoamHandle................................................................................................................................... |
39 |
Parameter name: UMTS _DNS1_.............................................................................................................................................. |
40 |
Parameter name: UMTS _DNS2_.............................................................................................................................................. |
40 |
Parameter name: ISP_Username.............................................................................................................................................. |
40 |
Parameter name: ISP_Password............................................................................................................................................... |
41 |
Parameter name: UMTS_APN.................................................................................................................................................... |
41 |
Parameter name: RemServAddr............................................................................................................................................... |
41 |
Parameter name: RemServPort................................................................................................................................................. |
41 |
Parameter name: SMS_ServCenterAddr................................................................................................................................ |
42 |
Predefined SMS |
|
Parameter name: Predef_XMIT_Busy..................................................................................................................................... |
43 |
Parameter name: Predef_XMIT_Txt......................................................................................................................................... |
43 |
Parameter name: Predef_XMIT_Dest...................................................................................................................................... |
44 |
Parameter name: XMIT_Dest..................................................................................................................................................... |
44 |
Parameter name: XMIT_Txt........................................................................................................................................................ |
45 |
Parameter name: XMIT_Request.............................................................................................................................................. |
46 |
Parameter name: XMIT_Txt_Coding....................................................................................................................................... |
46 |
Parameter name: Rcv_Indication............................................................................................................................................. |
47 |
Parameter name: Rcv_Originator............................................................................................................................................. |
47 |
Parameter name: Rcv_Timestamp........................................................................................................................................... |
47 |
Parameter name: Rcv_Txt........................................................................................................................................................... |
48 |
Parameter name: Rcv_Txt_Coding.......................................................................................................................................... |
48 |
Power Management |
|
Parameter name: Time_To_Sleep............................................................................................................................................ |
49 |
Parameter name: Enbl_Wake-Up_Flags................................................................................................................................ |
49 |
Parameter name: Shut_down_DelayTm............................................................................................................................... |
49 |
Parameter name: CyclicWakeupTm........................................................................................................................................ |
50 |
Device I/O |
|
Parameter name: Clamp15......................................................................................................................................................... |
51 |
4 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual
WS403x/WS503x Function Block Library
About this manual
Organization and Headings
To help you quickly find information in this manual, the material is divided into sections, topics, subtopics, and details, with descriptive headings set in bold type. Chapter or section titles appear at the top of every page in large bold type.
Special Text Formatting
Controls and indicators are set in bold black type.
WS FW, WS Configurator and Default Configuration
W Warning
The WS function block is complaint with the WS403x/WS503x FW version > 12.00 with the unit Configured with the DanfossDefault 2.0 configuration.
Most of the objects are available also on previous FW version, but in that case it is recommended to check the object index and sub-index.
In case of WS503x the DanfossDefault 2.0 configuration is designed to manage the information available on CAN1 and not on CAN2.
In case of WS customized configurations it’s required to check the alignment of the objects information before to use the blocks. In case of more clarifications, please contact Danfoss support.
WS403x/ |
WS |
WS Default Configuration |
WS compliance |
WS503x |
Configurato |
|
|
FW |
r Version |
|
|
Version |
|
|
|
|
|
|
|
10.04 to |
2.02.05 to |
WS403_DanfossDefault |
|
12.00 |
2.02.08 |
WS403-J_DanfossDefault |
|
|
|
WS503_DanfossDefault |
|
|
|
WS503-BP_DanfossDefault |
|
|
|
|
|
> 12.00 |
> 2.02.08 |
WS403_DanfossDefault 2.0 |
|
|
|
WS403-J_DanfossDefault 2.0 |
|
|
|
WS503_DanfossDefault 2.0 |
|
|
|
WS503-BP_DanfossDefault 2.0 |
|
|
|
|
|
© Danfoss | May 2016 |
AQ00000215en-US0101 | 5 |
User Manual
WS403x/WS503x Function Block Library
Introduction
The WS Function Block is intended to be used with Danfoss Power Solutions WS403x and WS503x devices.
The communication type is based on the CAN 2.0 A/B network.
Only one parameter from the WS device can be read or written at a time.
Blocks Structure
At the top level the compliance block named WS_Config has the following structure and interface:
Item |
Description |
|
|
|
|
CAN |
Bus used to determine which physical CAN bus available on the ECU and which physical |
|
|
CAN port of the hardware is used to receive the data from (this variable can be found in the |
|
|
CAN sub-bus if using the Main Template). |
|
|
• |
Value range: NA |
|
• |
Unit: NA |
|
|
|
Node |
WS403x/WS503x CAN Bus address (WS403x/WS503x Device CANopen Node ID parameter |
|
|
value) |
|
|
• |
Parameter Type: U8 |
|
• Value range: between 1 and 127 |
|
|
• Default value: 0x25 (37 decimal) |
|
|
• |
Unit: NA |
|
|
|
Enable |
CANopen SDO communication: |
|
|
Value Range: |
|
|
• False (Disable CANopen SDO communication, NMT is still available to reset the WS |
|
|
• True (Enable CANopen SDO communication) |
|
|
|
|
ResetWS |
A positive transition will send a reset command to WS403x/WS503x |
|
|
Parameter Type: Boolean |
|
|
Default value: 0 |
|
|
Unit: NA |
|
|
Value range: |
|
|
• |
False (No effect) |
|
• |
True (Reset WS403x/WS503x) |
|
|
|
ObjRqst & Objects |
Bus that contains selected WS403x/WS503x Object Sets buses: |
|
|
• |
Accelerometer_ |
|
• Device_Vars_ |
|
|
• Local_Geofence_ |
|
|
• |
Logging_ |
|
• Mobile_Vars_ |
|
|
• |
Positioning_ |
|
• Remote_Safety_ |
|
|
• Security_Vars_ |
|
|
• |
SMS_ |
|
• |
Custom_ |
|
|
|
Block Version |
It indicates the released version of the block |
|
|
|
|
Status |
Status output, a bitwise code where multiple items can be reported at a time: |
|
|
• |
0x0000: Status OK |
|
• 0x8008: A parameter value is out of range |
|
|
|
|
|
|
Block will not store data in this case. Send and Receive capabilities are also disabled. |
|
|
|
6 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual
WS403x/WS503x Function Block Library
Introduction
(continued)
Item |
Description |
|
|
Fault |
Fault output, a bitwise code where multiple items can be reported at a time: |
|
• 0x00: Status OK |
|
• 0x01: Aborted while we tried to read |
|
• 0x02: Local device aborted while we tried to read |
|
• 0x04: Aborted while we tried to write |
|
• 0x08: Local device aborted while we tried to write |
|
|
CommData |
Bus that includes the signals used to define the status of the communication with WS403x/ |
|
WS503x: |
|
Upload: Bus that contains diagnostic communication information being read. |
|
Download: Bus that contains diagnostic communication information being written. |
|
Busy: communication with WS403x/WS503x in progress. |
|
• Parameter Type: Boolean |
|
• Value range: False / True |
|
• Unit: NA |
|
|
Going in one level to the WS_Config page, more details are available in order to facilitate the developers in the usage of the WS Library.
Four pages are shown:
•WS_Objects includes the details of all available objects for communication
•SDO_Communication: Service Data Objects (SDOs) are used for direct access to WS403x/WS503x devices. With these service data objects, WS403x/WS503x objects can be read and written, where communication always takes place as a logical 1:1 connection between two nodes (e.g. a configuring node and a node to be configured). This page is blocked and can’t to be modified.
•Inputs: includes more details about the inputs of WS_Config page
•Outputs: includes more details about the outputs of WS_Config page
Going into the WS Objects page the user can include different Objects Sets specific for the WS403x or WS503x based on the unit used.
Each Objects Set has an input bus (ObjRqst) and an output bus (Object). By default only a subset of the supported object are already included (Device_Vars_ and Positioning_).
© Danfoss | May 2016 |
AQ00000215en-US0101 | 7 |
User Manual
WS403x/WS503x Function Block Library
Introduction
The Objects Sets can be added to the WS Objects page from the WS hardware tab and are based on different WS functionalities.
The input and output buses of the added Object Sets must be connected to the same bus included on the WS Objects page.
WS403x/WS503x Object
Each object is described by the following details:
•Parameter name: a symbolic name of the object
•Index: the 16-bit address to access information in the object
•Subindex: for specific objects the address is extended by a supplemental 8-bit address
•Data Type: gives the data type of the variable (or the data type of all variables of an array)
•Access Type: which gives information on the access rights for this entry (attribute), can be:
0.Read-Only
1.Write-Only
2.Read/Write
•Low Limit: the limit on the lower side of the object value
•High Limit: the limit on the higher side of the object value
Object Access
Going one level inside an Object Set (i.e. Device_Vars) are shown the related objects:
8 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual
WS403x/WS503x Function Block Library
Introduction
The object we’re looking for is DevCfg_VerStr and the related page includes the object details.
It’s important to note:
•Object description
•Data Type: String
•Access Type: R/W
On the outer level you can access the object by following the bus structure, the bus includes the following available signals:
© Danfoss | May 2016 |
AQ00000215en-US0101 | 9 |
User Manual
WS403x/WS503x Function Block Library
Introduction
Item |
Description |
|
|
|
|
ObjRqst |
Bus that include all the parameter buses that contains the most important WS403x/WS503x |
|
|
Objects Sets bus. Each Object Sets buses includes the following control signals: |
|
|
|
|
|
Read: request a read an object from WS403x/WS503x |
|
|
Only available for the objects that have the R (Read) permission. |
|
|
• |
Parameter Type: Boolean |
|
• |
Value range |
|
|
‒ False (Do not read the object) |
|
• |
‒ True (Read the object from the WS403x/WS503x) |
|
Unit: NA |
|
|
|
|
|
Write: request to write to an object on the WS403x/WS503x |
|
|
Only available for the objects that have the W (Write) permission. |
|
|
• |
Parameter Type: Boolean |
|
• |
Value range |
|
|
‒ False: Do not write an object |
|
• |
‒ True: Write “*_Data” to the object on WS403x/WS503x |
|
Unit: NA |
|
|
|
|
|
Length: Determines the length of the data to be sent, minimum size is one. |
|
|
• |
Parameter Type: U8 |
|
• Value range: 1 to 100 |
|
|
• |
Unit: NA |
|
|
|
|
Str_Data: Is always an array that contains the data to be written. If the object is Read only |
|
|
set to an array of size one with any data |
|
|
• |
Parameter Type: *_Data(*) |
|
• Value range: 0 to 255 |
|
|
• |
Unit: NA |
|
|
|
On the WS_Config page the output CommData Bus contains communication data for the current message. The Upload bus is shown below. The Download bus has a similar set of signals.
10 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual
WS403x/WS503x Function Block Library
Introduction
The data that is read from an object is placed into the Objects bus and will follow a similar bus architecture to access the signals.
Item |
Description |
|
|
|
|
Objects |
Bus that include all the Object Sets buses that contains the most important WS403x/ |
|
|
WS503x objects. Each Object Set buses includes the following control signals: |
|
|
• Str_Data: Contains the data read from the object, the data type varies. See |
|
|
|
ObjDict_DataType on this bus for real-time information to process the data. |
|
|
‒ Parameter Type: Array[x]U8 |
|
|
‒ Value range: number of bytes varies |
|
• |
‒ Unit: NA |
|
ObjDict_X (x): various parameters that give information about the related object |
|
|
|
‒ Value range: NA |
|
• |
‒ Unit: NA |
|
ReadSuccess: Pulses true when an object was successfully read, see Data for the |
|
|
|
updated information. |
|
|
‒ Parameter Type: Boolean |
|
|
‒ Value range: False / True |
|
• |
‒ Unit: NA |
|
WriteSuccess: Pulses true when an object was successfully written. |
|
|
|
‒ Parameter Type: Boolean |
|
|
‒ Value range: False / True |
|
|
‒ Unit: NA |
The information about the Objects are also available on the bus and can be used for processing:
© Danfoss | May 2016 |
AQ00000215en-US0101 | 11 |
User Manual
WS403x/WS503x Function Block Library
Introduction
The full interface to a single R/W object:
When reading or writing an object it is recommended to monitor the Read/WriteSuccess to verify that the message was properly received. By monitoring the Fault signal one can see if communications were aborted.
Item |
|
Description |
|
|
|
Status |
|
Status output, a bitwise code where multiple items can be reported at a time: |
|
|
• 0x0000: Status OK |
|
|
• 0x8008: A parameter value is out of range |
|
|
|
|
|
Note: Block will not store data in this case. Send and Receive capabilities are also disabled |
|
|
|
Fault |
|
Fault output, a bitwise code where multiple items can be reported at a time: |
|
|
• 0x00: Status OK |
|
|
• 0x01: WS403 aborted while we tried to read |
|
|
• 0x02: Local device aborted while we tried to read |
|
|
• 0x04: WS403 Aborted while we tried to write |
|
|
• 0x08: Local device aborted while we tried to write |
|
|
|
Custom objects
Custom_ Object Set can be used to include additional objects that not are included to the WS403x/ WS503x Danfoss Default Configuration 2.0 (i.e. some internal variables used to map customized information received from CAN bus). In that case it is recommended to rename the page with the name of the Group of Objects (press Q than, click on the page and edit the page name),
12 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual
WS403x/WS503x Function Block Library
Introduction
Then enter the page:
Write the description of the Object Set and based on the different Objects type use the predefined pages for each object.
Change the name of the page with the name of the object, then enter to the object page and set the object characteristics (index, sub-index, the bus names will need to be updated, etc…).
Do not introduce WS objects that are not available on the WS unit selected (i.e. Objects specific for
WS503 are not included on WS403 or customized objects not defined on WS unit), for more details see
Appendix A.
Objects that are unneeded can be deleted.
If a duplicated Object Set is placed on the project the ‘linked page’ symbol will be shown on the page and to the end of page name will be added automatically and index number (PageName_# #: index number).
Change the bus names 'Custom' and 'Obj_Name_Str' according with the custom object created (object group and object name).
Connect the signals Str_Data, Length, Read and Write to the application in order to manage the object. Assign CP to all the relevant object characteristics (xx_Data, ObjDict_Index, ObjDict_SubIndex, etc...).
We recommend that the application developer include the expected object signals control (for example the signal range limitation check, etc..).
© Danfoss | May 2016 |
AQ00000215en-US0101 | 13 |
User Manual
WS403x/WS503x Function Block Library
Device variables
WS403x and WS503x has some variables that can be used to manage the behavior of the device . Each device variable have a specific page and indicate the index and sub-index address. Each page has an input bus (ObjRqst) and an output bus (Object)
The device parameters require the WS to reset before they take effect.
Parameter name: DevApp_MasterMode
Define the WS403x or WS503x connection mode to DTS portal. The device mode will be active after a reset of the unit. If bit 7 is set when writing the value, then the reset will be performed immediately.
DevApp_MasterMode |
Values |
|
|
Index |
0x5353 |
|
|
Subindex |
0x00 |
|
|
Data Type |
U8 |
|
|
Access Type |
R/W |
|
|
Low Limit |
0 |
|
|
High Limit |
255 |
|
|
Default Value |
2 |
|
|
Values description:
•0: Data Logging/File Transfer mode
•2: Real Time Connection mode (Default value)
Parameter name: DevCfg_VerStr
User defined text to describe the current configuration version.
Change this description every time you create a customized DOD configuration and use to add a version number.
DevCfg_VerStr |
Values |
|
|
Index |
0x5FFA |
|
|
Subindex |
0x01 |
|
|
Data Type |
array of character (string) |
|
|
Access Type |
R/W |
|
|
Low Limit |
0 |
|
|
High Limit |
32 characters |
|
|
Default Value |
‘WSxxx Danfoss Default 2.0’ |
|
|
14 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
User Manual
WS403x/WS503x Function Block Library
Device variables
Parameter name: OperationTmTot
Total WS403x/WS503x operation time expressed in [sec].
OperationTmTot |
Values |
|
|
Index |
0x4000 |
|
|
Subindex |
0x22 |
|
|
Data Type |
U32 |
|
|
Access Type |
RO |
|
|
Low Limit |
0 |
|
|
High Limit |
4294967295 |
|
|
Default Value |
0 |
|
|
|
|
the value 0x80000000 indicates an invalid value so repeat the upload of the value again.
Parameter name: CAN1_NodeID
WS403x/WS503x Node ID for CAN1 interface
CAN1_NodeID |
Values |
|
|
Index |
0x4050 |
|
|
Subindex |
0x03 |
|
|
Data Type |
U8 |
|
|
Access Type |
R/W |
|
|
Low Limit |
1 |
|
|
High Limit |
127 |
|
|
Default Value |
37 (0x25) |
|
|
Parameter name: CAN1_Baud_Rate
Available Baud Rates on CAN1 Interface.
CAN1_Baud_Rate |
Values |
|
|
Index |
0x4051 |
|
|
Subindex |
0x03 |
|
|
Data Type |
U8 |
|
|
Access Type |
R/W |
|
|
Low Limit |
0 |
|
|
High Limit |
10 |
|
|
Default Value |
3 |
|
|
Values description:
•0: 1.000.000 baud
•1: 800.000 baud
•2: 500.000 baud
•3: 250.000 baud (Default Value)
•4: 125.000 baud
•5: 100.000 baud
•6: 50.000 baud
•7: 20.000 baud
•8: 10.000 baud
© Danfoss | May 2016 |
AQ00000215en-US0101 | 15 |
User Manual
WS403x/WS503x Function Block Library
Device variables
•9: 83.333 baud
•10: Customer specific Baud Rate: use Device Variable SFR-CAN-Baud Rate
The PLUS+1 supported baudrates are:
•1.000.000 baud
•500.000 baud
•250.000 baud (Default Value)
•125.000 baud
•100.000 baud
•50.000 baud
Parameter name: Dis_En_Objs
Switch ON/OFF CANopen Objects access (from the CAN side).
Dis_En_Objs |
Values |
|
|
Index |
0x20F4 |
|
|
Subindex |
0x00 |
|
|
Data Type |
U8 |
|
|
Access Type |
R/W |
|
|
Low Limit |
0 |
|
|
High Limit |
FF |
|
|
Default Value |
0 |
|
|
Values description:
•0x00: CANopen Stack completely active (Default Value)
•0x01: The following CANopen Objects are disabled
‒SDO-Server-Object
‒SDO-Client-Object
‒NMT-Object
Parameter name: RemoteSafetyFncAct
Switch ON/OFF the remote safety function activated by the configured CAN message.
RemoteSafetyFncAct |
Values |
|
|
Index |
0x4001 |
|
|
Subindex |
0x02 |
|
|
Data Type |
U8 |
|
|
Access Type |
R/W |
|
|
Low Limit |
0 |
|
|
High Limit |
1 |
|
|
Default Value |
1 |
|
|
Values definition:
•0: Full free access of read and write to the remote application
•1: Limited access to the remote application active, read of data is not limited (default value)
To disable the remote safety mechanism: 1. set the variable to 0
16 | © Danfoss | May 2016 |
AQ00000215en-US0101 |
Loading...