Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 5.47 KB

README.md

File metadata and controls

51 lines (37 loc) · 5.47 KB

Breakout Gardener is a framework application based on Node.js® using the i2c-bus library, typically to be run on a Raspberry Pi. The name is a pun on the Pimoroni Breakout Garden, as the project started out as a way to present various sensor data on that system's OLED display. As geeky projects often do, however, it eventually grew into something bigger, with more elaborate interworking...

Breakout Gardener currently supports the following devices and sensors (I2C unless otherwise noted) through modules:

  • ADS1015: Texas Instruments ADS1015 Analog-To-Digital Converter (example)
  • ADT7410: Analog Devices ADT7410 Digital Temperature Sensor (example)
  • ADXL343: Analog Devices ADXL343 Triple-Axis Accelerometer (example)
  • AS7262: AMS AS7262 6-channel Spectral Sensor (example)
  • BMP280: Bosch Sensortec BMP280 Barometric Pressure Sensor (example)
  • CAP1166: Microchip Technology CAP1166 Capacitive Touch Controller (example)
  • DRV2605: Texas Instruments DRV2605 based Pimoroni Linear Actuator Haptic Breakout (link)
  • DS18B20: Maxim Integrated DS18B20 Digital Thermometer (1-Wire) (example)
  • HT16K33: Holtek HT16K33 LED Controller Driver based Pimoroni Four Letter pHAT (link)
  • IS31FL3731 RGB+WHITE: Integrated Silicon Solution Inc (ISSI) IS31FL3731 Matrix LED Driver (RGB, white)
  • LSM303D: STMicroelectronics LSM303D eCompass 3D Accelerometer and 3D Magnetometer (example)
  • MCP9808: Microchip Technology MCP9808 Digital Temperature Sensor (example)
  • SGP30: Sensirion SGP30 Indoor Air Quality (TVOC and CO2eq) Gas Sensor (example)
  • SH1107: Display Future / Sino Wealth SH1107 Dot Matrix (128x128 pixel) Mono OLED Driver/Controller (example)
  • SHT31D: Sensirion SHT31-D Humidity & Temperature Sensor (example)
  • TCS3472: ams TCS3472 Color Light Sensor (example)
  • TRACKBALL: Pimoroni Trackball Breakout (link)
  • VCNL4010: Vishay Semiconductors VCNL4010 Proximity/Light Sensor (example)
  • VEML6075: Vishay Semiconductors VEML6075 UVA and UVB Light Sensor (example)

...as well as the following exclusive add-on module for electric car owners like myself... 😀

  • KEBAP30: KEBA KeContact P30 series wallbox charging station (link)

It also supports additional display modes through its SYSTEM, CLOCK and KOMPIS modules, Apple® HomeKit™ integration through selected proxy modules for HAP-NodeJS, data exposure and related visualization through its PROMETHEUS module, as well as a HTML5/CSS3 browser DASHBOARD module (see screenshot of version R2B above) that provides an overview of the current status and readings of all sensors and devices available on the system (nb. the "Shop" button is there just to support the tinkering community's favourite suppliers; Pimoroni (UK) and Adafruit Industries (US) (no affiliation to either, I just like their products and geeky dedication to the cause 😉)).

Anyway, without further ado:

- Install Node.js (I have tested with v10.16.x LTS)
- Clone this repository
- Install i2c-bus (I have tested with v5.1.0)
- Run!

Enjoy! 😎

...and if you do, please Star, and perhaps also tag me on Twitter (@xoblite #BreakoutGardener). Thanks! 😄

BR//KHH [xoblite]

========================

THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

© 2018-2019 Karl Henrik Henriksson / breakouts.xoblite.net. All trademarks are property of their respective owners.