1
0

readme.txt 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. _Note: Please check important notes at the bottom to avoid common errors using this sdk_
  2. License and Copyright:
  3. -------------------------
  4. This software is subject to the license described in the License.txt file
  5. included with this software distribution. You may not use this file except in compliance
  6. with this license.
  7. Copyright (c) Dynastream Innovations Inc. 2016
  8. All rights reserved.
  9. Project Hierarchy:
  10. ---------------------------
  11. ANT_LIB
  12. |
  13. |
  14. |
  15. -------------------------------------------------------------------------------------
  16. | | |
  17. | | |
  18. | | |
  19. ANT_DLL (C++) ------------------------------------- ANT_Unmanaged_Wrapper (C++)
  20. | | | | |
  21. | DEMO_HR_Transmitter (C++) DEMO_LIB (C++) DEMO_HR_RECEIVER (C++) |
  22. | |
  23. DEMO_DLL (C++) ANT_Managed_Library (C#)
  24. |
  25. |
  26. -------------------
  27. | |
  28. | |
  29. DEMO_NET (C#) ANT_NetDll_Demo (C#)
  30. The projects in this directory have been created designed and tested on Windows using the [Visual C++ and C# Compilers from Microsoft](https://www.visualstudio.com/en-us/products/vs-2015-product-editions.aspx).
  31. The library files and demo programs (except those marked as C# projects) use generic C++ and should compile
  32. with any standard C++ compiler, for example Borland Builder, GCC etc ...
  33. ---------------------------------------------------------------------------------
  34. Description of projects:
  35. =================
  36. Visual Studio Solution: ANT_Libraries.sln (C++)
  37. -----------------------------------------------------------
  38. The Visual studio solution included in this package have been designed to handle all
  39. the dependencies between projects. Make sure to open the solution files instead of
  40. individual project files. Just open and build ANT_Libraries.sln.
  41. ANT_LIB (C++)
  42. -------------------
  43. This is the main ANT library source code. It includes the low level serial
  44. driver required to communicate with the USB stick as well as ANT message framing,
  45. optional logging of serial messages exchanged between the PC and an ANT MCU, and
  46. ANT-FS client and host. This library can be statically linked into custom
  47. applications and provides greatest flexibility for custom implementations.
  48. ANT_DLL (C++)
  49. -------------------
  50. Based on the ANT library (ANT_LIB), this project defines a windows dynamic library
  51. interface. The DLL may be imported into other languages that support dynamic libraries.
  52. Use of the ANT DLL interface greatly simplifies PC application development with ANT.
  53. Binary release versions of this DLL (ANT_DLL.dll) are available in the BIN directory,
  54. along with all other necessary DLLs needed to run on a windows PC.
  55. DEMO_LIB (C++)
  56. -------------------
  57. A simple command line application built on top of the ANT library that demonstrates
  58. how to setup ANT channels and data messages.
  59. DEMO_HR_RECEIVER (C++)
  60. -------------------
  61. A simple command line application built on top of the ANT library that demonstrates
  62. how to setup ANT to simulate a heartrate monitor (HRM) reciever.
  63. DEMO_HR_TRANSMITTER (C++)
  64. -------------------
  65. A simple command line application built on top of the ANT library that demonstrates
  66. how to setup ANT channels and data messages to simulate a heartrate monitor (HRM) transmitter.
  67. DEMO_DLL (C++)
  68. -------------------
  69. A simple command line application built on top of the ANT DLL that demonstrates how
  70. to import the ANT DLL and setup ANT channels and data messages.
  71. ANT_Unmanaged_Wrapper (C++)
  72. -------------------
  73. Based on the ANT library (ANT_LIB) this project is a wrapper around the ANT library
  74. to expose the functionality of the library to the managed .NET environment.
  75. This project needs to be built separately, using the Visual C++ compiler.
  76. Binary release versions of this wrapper (ANT_WrappedLib.dll) are available in the BIN
  77. directory, along with all other necessary DLLs needed to run on a windows PC.
  78. ANT_Managed_Library (C#)
  79. -------------------
  80. This project is the wrapper to be used in the .NET environment. It exposes the
  81. functionality of the unmanaged wrapper in a controlled class environment.
  82. Binary release versions of this DLL (ANT_NET.dll) are available in the BIN
  83. directory.
  84. DEMO_NET (C#)
  85. -------------------
  86. A simple command line application built on top of the ANT_NET DLL that demonstrates how
  87. to import the managed library and setup ANT channels and data messages.
  88. ANT_NetDLL_Demo (C#)
  89. -------------------
  90. A simple GUI application built on top of the ANT_NET DLL that illustrates the usage
  91. of the managed library in graphical applications using WPF.
  92. ---------------------------------------------------------------------------------
  93. Important Notes to Avoid Common Errors:
  94. ==============================
  95. __Important Note: Silabs Dynamic Libraries__
  96. For ANT USB sticks that utilize the SiLabs CP210x USB/UART bridge it is necessary to include
  97. the Silabs DLLs in any projects that interface to a USB stick. The two DLLs
  98. required are:
  99. DSI_CP210xManufacturing_3_1.dll
  100. DSI_SiUSBXp_3_1.dll
  101. These are available in the BIN directory.
  102. <br>
  103. <br>
  104. __Important Note: Using the ANT Managed Library__
  105. The ANT Managed Library was designed for ease of integration of ANT in applications
  106. using the .NET framework.
  107. When using the ANT Managed Library, BOTH the unmanaged and managed wrapper
  108. need to be included. The two DLLs required are:
  109. ANT_WrappedLib.dll
  110. ANT_NET.dll
  111. The ANT_NET.dll needs to be included as a reference, while the ANT_WrappedLib.dll, along with
  112. the Silabs Dynamic Libraries, just needs to be present in the working directory of your
  113. application
  114. Binary versions of these are available in the BIN directory.
  115. Additionally, applications developed using the ANT Managed Library require the
  116. Microsoft .NET Framework v3.5 SP1. If .NET Framework v4 is already installed, you may need to
  117. install v3.5SP1 as well.
  118. http://www.microsoft.com/downloads/details.aspx?FamilyId=333325FD-AE52-4E35-B531-508D977D32A6&displaylang=en
  119. The ANT_WrappedLib.dll requires the Microsoft Visual C++ 2008 Redistributable Package
  120. http://www.microsoft.com/downloads/en/details.aspx?familyid=9b2da534-3e03-4391-8a4d-074b9f2bc1bf&displaylang=en
  121. <br>
  122. <br>
  123. __Important Note: Managed Applications for Windows 64-bit__
  124. All the binary versions of the libraries included in the BIN directory, including
  125. the Silabs Dynamic Libraries, are 32-bit DLL's. In order for the application to run
  126. on a 64-bit system, it is required to set the build configuration platform to x86,
  127. to ensure that the application runs in 32-bit mode.
  128. http://msdn.microsoft.com/en-us/library/ms973190.aspx
  129. <br>
  130. <br>
  131. __Important Note: A note about LOG files.__
  132. Log files are not generated by the ANT library and dynamic library by default. To enable
  133. logging, the library must be compiled with the DEBUG_FILE define and subsequently
  134. enabled using the DSIDebug::Init and DSIDebug::SetDebug function.
  135. In the projects included, this option is disabled by default.