Welcome to the 1-Wire SDK for Windows Help

Version 4.10 


The 1-Wire Software Development Kit (SDK) for Windows is divided into 2 sections, each representing a unique Applications Programmer Interface (API). The first focuses on the 1-Wire .NET libraries and is called Compact.NET API.  is focused on Windows CE/Mobile/Pocket PC using the Compact .NET framework.  The second API is the TMEX API. This is a basic low-level, natively-compiled API that performs 1-Wire communication and file structure primitives (as opposed to the .NET APIs that are high-level and object oriented). the TMEX API need the 1-Wire Drivers package installed before the example programs will run. Compact.NET programs can run without the 1-Wire Drivers as it can make calls to C#'s serial port library. 

So, if using TMEX, please install the latest 1-Wire Drivers installation package from http://www.maximintegrated.com/1-wiredrivers (Version 4.02 beta or higher) before using this kit.  The 1-Wire Drivers setup program will install the 1-Wire low-level device drivers that are used by both APIs to communicate through any supported 1-Wire port adapter (serial, parallel, or USB).  The setup program also installs all necessary code libraries for the TMEX API. This includes all appropriate TMEX API dlls and a JNI (Java Native Interface) dll that provides a Java interface to the TMEX API. In addition, the 1-Wire Drivers setup program installs the OneWireViewer software application. The OneWireViewer can demonstrate and exercise the features available on virtually any 1-Wire/iButton device.

The 1-Wire SDK for Windows supports the Microsoft Windows operating systems supported by a specific version of the 1-Wire Drivers.  Below are useful starting points in navigating the provided html help files.

OW.NET API

Unfurnatelly suppor for this API has been disconinued since Microsoft do not support this technology anymore


Compact.NET API

Compact.NET API.

TMEX API

TMEX API Introduction,
TMEX API Overview,
TMEX API Alphabetized Function List


Which API Should You Use?

The application developer is free to choose one of the three APIs presented above.  However, there are a few deciding factors that can influence the choice.  Here are a few of them:

1)  Rapid Application Development.  The TMEX API functions are lower level and deal with sending and receiving bytes to and from 1-Wire devices.  The programmer must write his own subroutines to actually "get" the temperature or do an A-to-D conversion for a particular 1-Wire device.

2)  API dependencies.  The TMEX API has fewer dependencies, so the application programmer has less to re-distribute with his 1-Wire application.  

3)  Windows CE/Mobile/Pocket PC Development.  The Compact.NET API is perfect for this.  Although it only provides DSPortAdapter functionality for now, it can be used to develop 1-Wire applications communicating through the serial port of the development machine without any 1-Wire Drivers installation.


1-Wire SDK Contents

For list of the contents of this SDK, please see:
Compact.NET SDK Contents, TMEX API SDK Contents


For more information
- iButton information:
https://www.maximintegrated.com/en/products/ibutton/ibutton.html
- Maxim Integrated information:
http://www.maximintegrated.com
- Technical Support Request Submission:
Technical Support