Organization and Headings..........................................................................................................................................................5
Special Text Formatting................................................................................................................................................................. 5
WS FW, WS Configurator and Default Configuration..........................................................................................................5
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
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.
FaultFault output, a bitwise code where multiple items can be reported at a time:
CommDataBus that includes the signals used to define the status of the communication with WS403x/
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
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
•
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 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_).
ItemDescription
ObjRqstBus 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.
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
‒
User Manual
WS403x/WS503x Function Block Library
Introduction
The full interface to a single R/W object:
Custom objects
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.
ItemDescription
StatusStatus 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
FaultFault 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_ 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),
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..).
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_MasterModeValues
Index0x5353
Subindex0x00
Data TypeU8
Access TypeR/W
Low Limit0
High Limit255
Default Value2
Values description:
•
•
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_VerStrValues
Index0x5FFA
Subindex0x01
Data Typearray of character (string)
Access TypeR/W
Low Limit0
High Limit32 characters
Default Value‘WSxxx Danfoss Default 2.0’
0: Data Logging/File Transfer mode
2: Real Time Connection mode (Default value)
WS403x/WS503x has an accelerometer that can detect acceleration on three axes, allowing it to sense
motion and orientation.
Each axial acceleration has a specific page and indicates the index and sub-index address. Each page has
an input bus (ObjRqst) and an output bus (Object)
Parameter name: Lateral
LateralValues
Index0x5E02
Subindex0x00
Data TypeS16
Access TypeRO
Low Limit0
High Limit65535
Default Value0
Parameter name: Longitudinal
Values description (J1939 format, PGN 61485):
ScalingRange
0.01 m/s² per bit-32000 to 32255 m/s²
The WS object dictionary defines this object as being a U16. The data is formatted here according to it's
associated SPN and then displayed as a S16.
LongitudinalValues
Index0x5E02
Subindex0x01
Data TypeS16
Access TypeRO
Low Limit0
High Limit65535
Default Value0
The following parameters define the ‘Remote Safety mechanism’. Each page has an input bus (ObjRqst)
and an output bus (Object).
The remote safety mechanism works with the reception of a specific configurable CAN Message and
should be extended to make it possible to use internal calculations or hardware inputs, for this purpose
the following variables are introduced
•
Remote Safety - State internal
•
Remote Safety - State combination
The remote safety mechanism will work as follows:
Parameter name: State
This state value is logically combined of the variables Remote Safety - State CAN and Remote Safety State internal.
The combination rule is defined by Remote Safety – Combination variable.
StateValues
Index0x5040
Subindex0x00
Data TypeU8
Access TypeRO
Low Limit0
High Limit255
Default Value0
A geo-fence is a virtual perimeter for a real-world geographic area. A local geo-fence could be
dynamically generated on WS403x/WS503x.
The process of using a geo-fence is called geo-fencing, and involves the position of WS403x/WS503x for a
location-based service (LBS) user entering or exiting a geo-fence.
This activity could trigger an alert to the device's user as well as SMS to selected receiver. Each page has
an input bus (ObjRqst) and an output bus (Object).
Parameter name: Mode
Configuration of the local Geofence functionality.
Values description:
•
•
•
•
Parameter name: Coord1_Long
Geofence Mode Circle: Longitude value of center
Geofence Mode Rectangle: Longitude value of first corner
ModeValues
Index0x200B
Subindex0x04
Data TypeU8
Access TypeR/W
Low Limit0
High Limit3
Default Value0
0: local Geofence disabled (Default value)
1: local Geofence activated - based on a circle with radius and center setting
2: local Geofence activated - based on a circle with radius setting and the center of the circle set on
current position
3: local Geofence activated - based on a rectangle
The WS object dictionary defines this object as being a U32. The data is formatted here according to it's
associated SPN and then displayed as a S32. When write this object the data type of ‘Data’ will depend on
the Geofence Mode.
Geofence Mode Circle: Radius of circle
Values description:
ScalingRange
1 m per bit0 to 4294967295
Parameter name: Coord2_Lat
Geofence Mode Circle: not used
Geofence Mode Rectangle: Latitude value of first corner
Coord2_LatValues
Index0x5E01
Subindex0x03
Data TypeS32
Access TypeR/W
Low Limit0
High Limit4294967295
Default Value0
Values description (J1939):
ScalingRange
0.0000001 deg-2100000000 to 2111081215 (North)
The WS object dictionary defines this object as being a U32. The data is formatted here according to it's
associated SPN and then displayed as a S32.
WS403x/WS503X parameters used to manage the logged data. Each page has an input bus (ObjRqst) and
an output bus (Object).
Parameter name: SendFileCmd
Write any value to this parameter to close the current log file and to trigger the sending to the DTS portal.
The file will only be sent to the server if the connection to the server is established. Otherwise it is stored
in the non-volatile memory of the device.
SendFileCmdValues
Index0x3333
Subindex0x2C
Data TypeU8
Access TypeWO
Low Limit0
High LimitFF
Default Value0
Parameter name: En_SD_CardLog
Enable the usage of the SD card if installed on WS403.
En_SD_CardLogValues
Index0x3333
Subindex0x2D
Data TypeU8
Access TypeR/W
Low Limit0
High Limit1
Default Value0
Values description:
•
•
When a server connection is established, the logged files will be transferred to the server and then
deleted from the local memory automatically.
Parameter name: FileHeaderText
This string will appear as a header of each log file.
0 OR no SD card inserted Log to internal data flash memory.
1 (Default value) AND SD card inserted Log to SD card
Index0x3333
Subindex0x1F
Data Typearray of char (string)
Access TypeR/W
Low Limit0
High Limit32 characters
Default Value‘WSxxx_DanfossDefault 2.0’
Parameter name: FileUploadPeriod
Period in minutes. When this time is elapsed, the logged file is closed and transmitted to the server. The
files will only be sent to the server if the connection to the server is established. Otherwise they are stored
in the non-volatile memory of the device. Set this value to 0 to deactivate period.
FileUploadPeriodValues
Index0x3333
Subindex0x1C
Data TypeU16
Access TypeR/W
Low Limit0
High Limit65535
Default Value5 [min]
Index0x3333
Subindex0xF9
Data TypeU8
Access TypeRO
Low Limit0
High Limit2
Default Value0
Values description:
•
0 – GSM/UMTS auto select (default value)
•
1 – GSM only
•
2 – UMTS only
Parameter name: Net_Mode_Cur
Network system mode
Net_Mode_CurValues
Index0x3333
Subindex0x1A
Data TypeU8
Access TypeRO
Low Limit0
High Limit7
Default Value0
Values description:
•
•
•
•
•
•
•
•
•
•
Parameter name: ActNetProvider
Contains the current used mobile network provider name.
0: Not registered for Packet Switched (PS) service – Initial network search or out of coverage
1: Registered for PS, 2G, GPRS available
2: Registered for PS, 2G, EDGE available
3: Registered for PS, 3G, WCDMA available
4: Registered for PS, 3G, HSDPA available
5: Registered for PS, 3G, HSUPA available
6: Registered for PS, 3G, HSDPA and HSUPA available
7: Registered for PS, 4G
8: Registered for PS, 2G, GPRS available, Dual Transfer Mode (DTM) available
9: Registered for PS, 2G, EDGE available, DTM available
ActNetProviderValues
Index0x50C0
Subindex0x00
Data Typearray of chars (string)
Access TypeRO
Low Limit0
If it’s not 0 you need to set the security variable “SIM PIN” to the correct value. Until you set a new value
for the SIM PIN no new connection attempt is started in order to prevent locking of the SIM card. In case
of more of 3 SIM PIN errors the SIM Card is blocked, remove the SIM Card and use a phone to introduce
the PUK code number and unblock the SIM Card.
Parameter name: StateMachErrCode
Status of the mobile communications when the last error occurred.
Read this value if the WS403x/WS503x is stuck during startup for more than a minute or if the UMTS LED
shows RED color. Send this value to the support to determine the reason for the problem.
StateMachErrCodeValues
Index0x3333
Subindex0x38
Data TypeU16
Access TypeRO
Low Limit0
High Limit0xFFFF
Default Value0
Parameter name: CMS_ErrNum
CMS (mobile network related) error code.
Last error code sent by mobile communications engine.
Read this value if the WS403x/WS503x is stuck during startup for more than a minute or if the UMTS LED
shows RED color. Send this value to the support to determine the reason for the problem.
Parameter name: CME_ErrNum
CME (mobile equipment related) error code.
Last error code sent by mobile communications engine.
Read this value if the WS403x/WS503x is stuck during startup for more than a minute or if the UMTS LED
shows RED color. Send this value to the support to determine the reason for the problem.
CMS_ErrNumValues
Index0x3333
Subindex0x55
Data TypeU32
Access TypeRO
Low Limit0
High Limit4294967295
Default Value0
CME_ErrNumValues
Index0x3333
Subindex0x56
Data TypeU32
Access TypeRO
WS403x/WS503x parameters to configure the SIM card used to establish the UMTS/GSM connection and
to set-up the communication to DTS server.
Parameter name: RemoteAccessPass
This is the password for remote access to be handled by the Client Software driver.
Parameter name: SIM_PIN
RemoteAccessPassValues
Index0x3333
Subindex0x06
Data Typearray of char (string)
Access TypeWO
Low Limit0
High Limit32 characters
Default Value‘GSMONLIN’
PIN number of the SIM card. Four-digit string which is required for registering with the UMTS network
provider.
SIM_PINValues
Index0x3333
Subindex0x07
Data Typearray of char (string)
Access TypeWO
Low Limit0
High Limit32 characters
Default Value‘’ empty
If the UMTS-Led of the device turns red, you possibly have entered a wrong PIN number.
Please take a look at the device variable "UMTS - SIM pin error flag" to ensure that the current PIN number
is correct.
Parameter name: UMTS_RoamHandle
Enable/Disable connection while roaming is active.
In order to automatically send SMS text messages up to 16 different pre-defined SMS text messages are
available together with up to 16 destination phone numbers and can be stored on WS unit (non-volatile
memory). In order to send the SMS message a text and destination can be referenced by an index.
It is possible to add dynamic data to the SMS text, you can use escape-sequences to refer data from the
internal object dictionary, the sequence will be replaced by the decimal representation of the value in
this object, in case of ASCII objects the text will replace the escape sequence.
Example:
<0x5209, 0x00> references object with index 0x5209 and sub-index 0, this sequence will be replaced by
the decimal representation of the value of this object, e.g. :50.31426. If the text is longer than the allowed
maximum character count, the length will be automatically limited to the maximum length.
Parameter name: Predef_XMIT_Busy
Predef_XMIT_BusyValues
Index0x5123
Subindex0x02
Data TypeU8
Access TypeR/W
Low Limit0
High Limit255
Default Value0
Values description:
•
0: if ready for new transmission
•
1: while a SMS is being sent
Parameter name: Predef_XMIT_Txt
Index of the predefined SMS text that should be sent.
Predef_XMIT_TxtValues
Index0x5123
Subindex0x0A
Data TypeU8
Access TypeR/W
Low Limit0
Index0x5123
Subindex0x0B
Data TypeU8
Access TypeR/W
Low Limit0
High Limit255
Default Value0
Parameter name: XMIT_Dest
Values description:
•
Predef_XMIT_Txt
And
•
Predef_XMIT_Dest
to a value between 1 and 16 to send a SMS.
Destination telephone number for transmit SMS.
XMIT_DestValues
Index0x5120
Subindex0x00
Data Typearray of chars (string)
Access TypeR/W
Low Limit0
High Limit32 characters
Default Value‘’ empty
WS403x/WS503x includes 16 preconfigured destination telephone numbers with the same characteristic
indicated above with the following sub-Index. By default the destination telephone number values are
empty.
Contains the SMS text to be sent. The value of any object dictionary entry can be added to the text this
way: <0xiiii, 0xss>. With iiii=index, ss=sub-index.
Example:
Device Name: <0x1008, 0x00>.
XMIT_TxtValues
Index0x5122
Subindex0x00
Data Typearray of chars (string)
Access TypeR/W
Low Limit0
High Limit160 characters
Default Value‘’ empty
WS403x/WS503x includes 16 preconfigured SMS texts with the same characteristic indicated above with
the following sub-Index.
By default the SMS text values are indicated below.
WS ObjectsSub-IndexDefault Value
SMS - Predefined Transmit Text 10AEmergency button
SMS - Predefined Transmit Text 20BEmergency button
pressed on
machine
<0x5122,0x19> at
pos
(<0x5209,0x00>,
<0x5208,0x00>)
pressed on
machine
<0x5122,0x19> at
pos
(<0x5209,0x00>,
<0x5208,0x00>)
The following parameters define the WS power management.
Parameter name: Time_To_Sleep
The parameter indicate the Time [sec] to enter WS unit in sleep mode.
Time_To_SleepValues
Index0x3333
Subindex0xFA
Data TypeU8
Access TypeWO
Low Limit0
High Limit255
Default Value0
When this value is set, no CAN messages will be sent from the device until it wakes up again. You can
wake up the device by a CAN message.
If the device is equipped with Terminal 15 ignition (KL15) input, it can also wake on a level change of it or
on detection of a specific acceleration force.
Value Description:
•
0 [sec] (default value)
Parameter name: Enbl_Wake-Up_Flags
This parameter is the enable wake-up functionality flags (this parameter is bit-coded):
Enbl_Wake-Up_FlagsValues
Index0x3333
Subindex0x37
Data TypeU8
Access TypeR/W
Low Limit0
High Limit0xFF
Default Value00 for WS403/WS503;
Value Description:
•
Bit 0: Wake-up on acceleration sensor value (see parameter "Acceleration Sensor Wake-up Force")
•
Bit 1: Cyclic wake-up after time (see parameter "Cyclic Wake-up Time")
•
Bits 2..6: reserved, set to 0
•
Bit 7: Extended PMM (monitoring of ignition input (KL15) active on level)
Parameter name: Shut_down_DelayTm
The parameter indicate the WS operating Time [sec] after recognizing ignition input (KL15) off-state then
go to sleep.
This function is only active if Bit 7 of the parameter "Power Management - Enable Wake-up Flags" is set.
2800 East 13th Street
Ames, IA 50010, USA
Phone: +1 515 239 6000
Danfoss
Power Solutions Trading
(Shanghai) Co., Ltd.
Building #22, No. 1000 Jin Hai Rd
Jin Qiao, Pudong New District
Shanghai, China 201206
Phone: +86 21 3418 5200
Products we offer:
Comatrol
www.comatrol.com
Schwarzmüller-Inverter
www.schwarzmuellerinverter.com
Turolla
www.turollaocg.com
Hydro-Gear
www.hydro-gear.com
Daikin-Sauer-Danfoss
www.daikin-sauer-danfoss.com
Bent Axis Motors
•
Closed Circuit Axial Piston
•
Pumps and Motors
Displays
•
Electrohydraulic Power
•
Steering
Electrohydraulics
•
Hydraulic Power Steering
•
Integrated Systems
•
Joysticks and Control
•
Handles
Microcontrollers and
•
Software
Open Circuit Axial Piston
•
Pumps
Orbital Motors
•
PLUS+1® GUIDE
•
Proportional Valves
•
Sensors
•
Steering
•
Transit Mixer Drives
•
Danfoss Power Solutions is a global manufacturer and supplier of high-quality hydraulic and
electronic components. We specialize in providing state-of-the-art technology and solutions
that excel in the harsh operating conditions of the mobile off-highway market. Building on
our extensive applications expertise, we work closely with our customers to ensure
exceptional performance for a broad range of off-highway vehicles.
We help OEMs around the world speed up system development, reduce costs and bring
vehicles to market faster.
Danfoss – Your Strongest Partner in Mobile Hydraulics.
Go to www.powersolutions.danfoss.com for further product information.
Wherever off-highway vehicles are at work, so is Danfoss. We offer expert worldwide support
for our customers, ensuring the best possible solutions for outstanding performance. And
with an extensive network of Global Service Partners, we also provide comprehensive global
service for all of our components.
Please contact the Danfoss Power Solution representative nearest you.
Local address:
Danfoss can accept no responsibility for possible errors in catalogues, brochures and other printed material. Danfoss reserves the right to alter its products without notice. This also applies to products
already on order provided that such alterations can be made without changes being necessary in specifications already agreed.
All trademarks in this material are property of the respective companies. Danfoss and the Danfoss logotype are trademarks of Danfoss A/S. All rights reserved.