1-Wire SDK for Windows Readme

Welcome to the 1-Wire SDK for Windows

Version 4.00 Beta 2 

 

The 1-Wire Software Development Kit (SDK) for Windows is divided into 3 sections, each representing a unique Applications Programmer Interface (API). The first section focuses on the 1-Wire .NET J# libraries called OW.NET API. The second section focuses on an API that is essentially a port of the OW.NET "DSPortAdapter" object to C#, called the Compact.NET API. It is primarily for Windows CE/Mobile/Pocket PC platforms using the Compact .NET framework but can also be used on full Windows platforms if only a minimal 1-Wire interface is needed. For now Maxim only provides the equivalent of the DSPortAdapter object in the Compact.NET API. However, an open-source effort is underway to provide more pure C# classes (such as OneWireContainers, MemoryBanks, etc). It is available from http://sourceforge.net/projects/owdotnet/. The third section is the TMEX API. This is a basic low-level, natively-compiled API that performs 1-Wire communication and file structure primitives. Both the OW.NET API and 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 for the DS9097U style adapters. However if the 1-Wire Drivers are installed, the Compact.NET library will call the native drivers through the TMEX API to support all adapter types. The 1-Wire Drivers package also includes a demonstration application, the OneWireViewer, that can exercise most 1-Wire/iButton devices. The 1-Wire SDK for Windows supports the same operating systems supported by a specific version of the 1-Wire Drivers. The latest 1-Wire Drivers support the following 32-Bit and 64-bit Microsoft Windows operating systems: Windows XP Service Pack 2 and higher, Windows Vista, and Windows 2008 (Server).

Kit Contents (by Subdirectory):

/Docs 

· Contains HTML documentation for each API. Start with opening the 1-Wire_SDK_Help.html file, or open the index.html files under each API subdirectory.

/Examples

· Contains example programs. Underneath this directory are directories specific to each API mentioned above. Underneath each API directory, the example programs are organized by compiler/language. Each compiler directory will have a \bin subdirectory where all the binaries for each compiled program for that compiler are located.

/Lib

· Contains the API libraries. These libraries are compiled against for each API example program, except for TMEX examples. The TMEX API libraries get installed by the 1-Wire Drivers installation package.

/Source

· Contains the source to the APIs. Each API is represented here except for the TMEX API, which is closed source.

What’s New in 4.00 Beta 2

· OW.NET

- Formerly this API was available for download separately, but has now been consolidated into the 1-Wire SDK for Windows.

- Upgraded to .NET framework 2.0 and J# redistributable 2.0 Second Edition. The library and executables are "AnyCPU" builds. This means they run as 32-bit processes under 32-bit operating systems, and 64-bit processes under 64-bit operating systems.

- All VB.NET examples are new.

- Support for the DS2431 has been corrected. Support for the DS28EC20, DS28EA00, and DS1922E have been added in the OneWireViewer and OW.NET API.

· Compact.NET

- New as a released project.

· TMEX

- New 64-bit programs have been added, specifically, loopit64.exe, swvc64.exe, and tempvc64.exe.

· OWCOM API

- Unfortunately, support for the OWCOM API has been discontinued because Microsoft no longer supports the underlying technology. However, an older version of this SDK with OWCOM examples will still be made available on-line for a limited time here: http://www.maxim-ic.com/products/ibutton/software/windowsdk/index.cfm

SDK Contents

 

OW.NET API SDK CONTENTS

COMPACT.NET API SDK CONTENTS
TMEX API SDK CONTENTS

For more information

· 1-Wire information: http://www.maxim-ic.com/1-wire

· iButton information: http://www.ibutton.com

· Technical support: http://support.maxim-ic.com/1-wire or http://support.maxim-ic.com/1-wire

· Discussion forum: http://discuss.dalsemi.com