Skip to content

Commit

Permalink
All modifications were comments to state that no pull-ups and pull-do…
Browse files Browse the repository at this point in the history
…wns were to be used in hardware or in the INPUT port configuration for the uC.

No functionality changes.
  • Loading branch information
jseibel6900 committed Dec 21, 2017
1 parent ce64875 commit ccd45ee
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ Installation instructions:

**** Next, set up your hardware and run the example application ************

**** IMPORTANT NOTE BEFORE BEGINNING -- The TS4231 is a 3.3V device and must only be used with a 3.3V Arduino board. Failure to do so will damage the TS4231.
**** IMPORTANT NOTES BEFORE BEGINNING
**** 1) The TS4231 is a 3.3V device and must only be used with a 3.3V Arduino board. Failure to do so will damage the TS4231.
**** 2) DO NOT add pull-up or pull-down resistors to the D and E signals.
**** 3) DO NOT configure the Arduino INPUT ports that connect to the D and E signals with a pull-up or pull-down function. They must be floating.

1) First, install the TS4231 Arduino library by following the instructions here:

Expand Down
5 changes: 5 additions & 0 deletions examples/ts4231_config_example/ts4231_config_example.ino
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@
#include <ts4231.h>

#define light_timeout 500 //500ms is a placeholder as this number will be system dependent

//IMPORTANT NOTE: If porting the TS4231 library code to a non-Arduino architecture,
//be sure that the INPUT ports assigned to the E and D signals are configured as
//floating inputs with NO pull-up or pull-down function. Using a pull-up or
//pull-down function on the inputs will cause the TS4231 to operate incorrectly.
#define device1_E_pin your_E_pin //User must replace your_E_pin with their pin number (compile error will occur if no number defined)
#define device1_D_pin your_D_pin //User must replace your_D_pin with their pin number (compile error will occur if no number defined)

Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=TS4231 Library
version=1.0.2
version=1.0.3
author=Triad Semiconductor
maintainer=Triad Semiconductor <info@triadsemi.com>
sentence=Triad Semiconductor library for configuring the TS4231 Light to Digital Converter.
Expand Down
4 changes: 4 additions & 0 deletions ts4231.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@
#include "ts4231.h"
#include <Arduino.h>

//IMPORTANT NOTE: If porting the TS4231 library code to a non-Arduino architecture,
//be sure that the INPUT ports assigned to the E and D signals are configured as
//floating inputs with NO pull-up or pull-down function. Using a pull-up or
//pull-down function on the inputs will cause the TS4231 to operate incorrectly.

TS4231::TS4231(int device_E_pin, int device_D_pin) {
configured = false;
Expand Down

0 comments on commit ccd45ee

Please sign in to comment.