Maxim Integrated OneWireViewer User Manual
Maxim > Design Support > Technical Documents > User Guides > APP 3358
Page 1 of 21
Keywords: onewireviewer, 1-wire,ibutton, onewire, viewer, software, evaluation, eval kit, java, web start, webstart, user's guide, manual, howto, debugging
USER GUIDE 3358
OneWireViewer User's Guide, Version 1.5
By: Bernhard Linke, Principal Member Technical Staff
Sep 25, 2009
This User's
Abstract:
devices.
Introduction
The OneWireViewer is a Java™ -based software package to explore Maxim's 1- Wire and iButton devices with a personal computer. The 1-Wire and iButton devices
communicate over a single data line plus ground reference, using the 1-Wire protocol. Several 1-Wire adapters are available for USB and serial ports. The
OneWireViewer provides a user interface to evaluate the unique features of 1 - Wire and i
Hygrochron™ (real-time temperature and humidity), A to D (analog to digital), clock, memory, and file operations.
Installation
Refer to application note 4373, "OneWireViewer and iButton® Quick Start Guide " for the installation instructions for the 1 - Wire Drivers, which also install the
OneWireViewer. For additional/expanded help, see application note 5057, "OneWireViewer Tips and Tricks ," starting with the section Identifying the System.
Uninstalling
Refer to the application note 5057, " OneWireViewer Tips and Tricks ," section How to Install a Newer OneWireViewer Version.
Program Main Window
The main window of the OneWireViewer consists of four areas: Device List (top left), 1-Wire Search Mode (bottom left), Tab area (to the right) and menus (top
row). The width of the device list/search mode area can be adjusted by horizontally moving the vertical scroll bar that separates these areas from the tab area. The
Device List/1-Wire Search Mode areas can be removed/restored by clicking on one of the tiny triangles to the right of the device list.
Guide explains the OneWireViewer software program and how it can be used to evaluate the unique features of 1 -Wire® and iButton®
Button products, including Thermochron® (temperature logging),
Viewer Menus
File
Close (to exit program)
Has a subtitle Alt-1 (instead of Alt+F4). The Program will end with Alt+F4 as well as Alt+1. The '1' must be pressed on the normal keypad, not the numeric keypad,
to be accepted.
View
Show Message Log (to read error messages)
Opens a new window that displays a device access log and error messages.
Show Tab in New Window (to view multiple functions or devices simultaneously)
Page 2 of 21
To use this function, first select a device, then select one of the available tabs. Then use Show Tab in New Window, which moves the selected tab into a window of
its own. The main window will then revert back to the Description tab.
Show Device Alternate Names (to see alternate names in the device list)
Example: Thermochron instead of DS1921G-F5 to the right of the ROM ID
Tools
Pick Adapter (to change the communication port and 1-Wire port adapter)
Opens a new window for selecting one of several 1 -Wire port adapters, port type, and port number. For more information see application note 5057,
"OneWireViewer Tips and Tricks," section How to Change 1-Wire Adapters and Ports .
XML Tagging (to load device tags that can be displayed in the device list)
Opens a new window to select the file that holds the XML tags of the devices in use. See application note 158, "1 -Wire® Tagging with XML," for tag specification
and how to create tag files that are compatible with the OneWireViewer.
1- Wire Speed (to select the preferred 1-Wire speed)
Allows selection of standard speed or overdrive speed. Most 1-Wire devices support both speed modes. To use overdrive speed, the port adapter must also support
overdrive. If overdrive is selected and the port adapter does not support overdrive, an error message will appear when trying to access an overdrive-supporting 1Wire device.
Device Poll Rate (to set the frequency at which the 1-Wire net is searched for devices)
The rates are 1s, 5s, 10s, 30s, 1min, 5min, and immediate poll. The typical value is 1s, which yields the fastest response.
Help
About (displays the version numbers of the software components that comprise the OneWireViewer)
Opens a window that displays: the site from which the source code of the 1-Wire API and OneWireViewer can be downloaded; the API version; the version numbers
of the various viewers; and the location of the onewireviewer.properties file on the local hard drive. The OneWireViewer is provided as a source code example in the
1- Wire API for Java Kit.
Viewer Window Areas
Device List
This is the area that displays the ROM IDs of devices on the network and the device part numbers/names. The 1-Wire Search Mode controls whether a device is
included in the list. Devices that arrive on the network are appended at the bottom of the list. If XML tags have been defined (see the section Viewer Menus, Tools,
XML Tagging above), the device list shows the tags instead of the part numbers/names. In addition, only the functionality associated with their tags is exercisable.
Below the device list, the total number of devices on the network and the type of port adapter are displayed. In this example, the adapter is a DS9097U. The { }
brackets around the adapter name indicate that it uses a native TMEX driver.
1- Wire Search Mode (affects the contents of the device list)
Show Normal Devices
When checked, the list shows all devices on the network.
Show Alarming Devices
When checked, the list shows only devices that respond to the Conditional Search ROM command, e.g., because of an alarming condition.
Show Chain Mode Devices
When checked, the list shows only devices that support the Chain Mode. This feature allows detecting the physical sequence of all the devices in a linear network
that are wired for Chain Mode. An example device is the DS28EA00 1-Wire digital thermometer.
Pause All Searching (to stop/restart searching the network for arriving/departing devices)
When checked, the 1-Wire network is no longer searched. This minimizes the communication traffic on the network (e.g., to facilitate catching events with an
oscilloscope), and freezes the content of the device list. An error message will be generated if one selects a device that has departed from the network. With the
searching paused, one cannot access devices that have arrived because they are not included in the device list. To end the pause, check Show Normal Devices.
Tab Area
Once a device is selected, the Description tab appears with a short description of the device. Depending on the device, additional tabs may appear that provide
access to the applicable device function viewers. See the Supported Devices table below for a list of devices and applicable device viewers.
The 1-Wire and iButton products support a broad set of features. The following table, sorted by family code, shows the applicable device function viewers.
Page 3 of 21
Supported Devices
Page 4 of 21
Supported
Devices
DS1990A,
DS1990R
DS1993L 06
DS1992L 08
DS1982,
DS2502
DS1995L 0A
DS1985,
DS2505
DS1996L 0C
DS1920,
DS1820
DS2406 12
DS1971,¹
DS2430A¹
DS28E04 1C
DS2450 20
DS1921 21
DS1822 22
DS1973,
DS2433
DS1904,
DS2415
DS2438 26
DS2417 27
DS18B20 28
DS2408 29
DS2431 2D
DS2760,
DS2762
DS1977 37
DS2413 3A
DS1922,²
DS2422²
DS1923 41
DS28EA00³ 42
DS28EC20 43
¹It is possible
²A-to- D support applies to the DS2422 only.
³This device supports Chain Mode; see data sheet for more information.
Family
Code
01
09
0B
10
14
23
24
30
41
to format this device; however, there is no memory left to store a file.
Thermochron Mission Temperature Humidity SwitchAtoDClock Memory File Password
( )
(
)
Device Function Viewers
Thermochron (Temperature Logging)
The Thermochron viewer gives real- time information on the mission parameters and status of the selected Thermochron iButton connected to the OneWireViewer.
The user can start a new mission, end (disable) a running mission, view and download the mission's temperature log, and see (but not download) the mission's
temperature histogram and alarm log. Similar to the Mission viewer, the Thermochron viewer is used only for the DS1921 series of temperature loggers and their
features. See also the Supported Devices table above.
The tab structure of the Thermochron viewer consists of two areas: Command (top), and device data tabs (bottom). The Command tab includes three buttons to
operate the device's logging function and to select the temperature scale (°C or °F). Depending on the size of the Thermochron tab, there can be scroll bars for both
areas.
Sample Thermochron Viewer Tab
Page 5 of 21
Thermochron Viewer Commands
Refresh Mission Results (to read device status, temperature, histogram, and alarm log)
This allows a mission to be monitored in progress without changing device viewers.
Start New Mission (to allow the user to enter all data necessary to start a new mission)
This command opens a new window in which the user enters the parameters for the next mission.
Disable Mission (to stop a running mission)
This command stops a mission. The collected data remains stored in the device.
When the Thermochron Tab is active, the Thermochron viewer:
Automatically reads the device status, temperature, histogram, and alarm log.
Automatically displays the device status on the Status tab.
Displays the temperature log as a graphic (if you open the Temperatures tab).
Displays the temperature histogram in text form (if you open the Histogram tab).
Displays the alarm log in text form (if you open the Alarm Log tab).
Allows the temperature scale to be changed between °C (default) and °F; the selected scale is memorized.
Allows activation of automatic rescaling of the temperature log graph.
Allows the graph data to be exported by using the clipboard or saving as a CSV (Excel®) file.
Sample Temperature Log Graphic
Page 6 of 21
Sample Histogram
Sample Alarm Log
Start New Mission Window (default)
Page 7 of 21
It is recommended that you synchronize the device's real - time clock (RTC) to the PC. Enter the mission start delay in minutes. Sampling rate, mission start delay,
temperature alarms, and rollover depend on the technical requirements of the mission. See the respective DS1921-series data sheets for guidelines. The clock
alarm functions are not relevant for a device on a mission. The default settings, therefore, can be accepted.
Notes:
The time reference in the alarm log (e.g., "Low alarm started at: 21") indicates minutes after the start of the mission. To find the day and time when the alarm
occurred, manually add the indicated time to the mission start date and time.
The Thermochron viewer does not enable the temperature-high and temperature-low alarm search. As a result, if a temperature alarm occurs during the
mission, the device will not be identified as an alarming device unless there is also a timer alarm.
For the alarm -frequency and alarm -time values to be updated in the device, Enable Clock Alarm? must be checked. Otherwise, the current (i.e., previous
mission's) settings remain in effect for the new mission.
When a mission extends across time zones, the time shown in the exported data (clipboard or csv file) refers to the time at the location where the mission was
started.
Mission (Temperature and Humidity Logging)
The Mission viewer gives real-time information on the mission parameters and status of the selected Temperature Logger iButton connected to the OneWireViewer.
The user can start a new mission, end (disable) a running mission, view and download the mission's temperature and humidity. The Mission viewer is similar to the
Thermochron viewer, but is used for the DS1922 series of i
logger. See also the Supported Devices table above.
The tab structure of the Mission viewer consists of two areas: Command (top), and device data tabs (bottom). The Command tab includes three buttons to operate
the logging function of the device, and to select the temperature scale (°C or °F). Depending on the size of the Mission tab, there may be scroll bars for both areas.
Button products, the DS1923 Hygrochron and its features, and the DS2422 1-Wire temperature/data
Loading...