Giter Club home page Giter Club logo

cryptid-bottles's Introduction

Cryptid Bottles

WIP board and LED strands

Boards

Setup

  1. Copy wifi-config.example.h to wifi-config.h and fill in values.
  2. Install board following instructions.
  3. Install required libraries (and their dependencies) via Arduino IDE.
    1. Adafruit SAMD
    2. Adafruit SleepyDog
    3. Adafruit NeoPXL8 - see docs
    4. Adafruit NeoPixel
    5. Adafruit ZeroDMA
    6. Adafruit WiFiNiNA - manual install, forked from arduino, see docs
    7. Adafruit INA219
    8. MQTT_Looped
  4. For VS Code, compile to finish intellisense setup.
    1. .vscode/c_cpp_properties.json may update.
  5. Configure defines in cryptid-bottles.h and src/pxl8.h if relevant.

HW Config

NeoPXL8 Connections

  • Output #0 comes from RX (Available; shared by ESPRX)
  • Output #1 comes from TX (Available; shared by ESPTX)
  • Output #2 comes from D9 (Available)
  • Output #3 comes from D6 (Available)
  • Output #4 comes from D13 (Unavailable, used by ESPCS!)
  • Output #5 comes from D12 (Unavailable, used by ESPRST!)
  • Output #6 comes from D11 (Unavailable, used by ESPBUSY!)
  • Output #7 comes from D10 (Available; shared by ESPGPIO0)

Airlift Connections

  • SPIWIFI from SPI
  • SPIWIFI_SS from D13
  • ESP32_RESETN from D12
  • SPIWIFI_ACK from D11
  • ESP32_GPIO0 disabled

Other Connections

  • Pin D8 is connected to the onboard mini NeoPixel.
  • Analog pin A0 used for random seed.
  • Current sensor INA219 connects over I2C at its default address, 0x40.

MQTT Control

Bottles can be controlled over MQTT.

  • Birth and LWT messages sent on cryptid/bottles/status as online/offline.

  • Status messages sent on cryptid/bottles/state in JSON.

  • Discovery (auto-config) messages published for Home Assistant (prefix homeassistant/) on startup, reconnection, and Home Assistant birth messages.

  • Commands for:

    Topic Payload
    on ON/OFF
    brightness 0-255
    rgb 0-255,0-255,0-255, e.g. 0,128,200
    white_balance 30-90 in mireds, e.g. 40, 65
    white 0-255
    effect Default, Glow, Glow White, Faeries, Rain, Rainbow, Test, Test White, Illuminate, Warning
    glow_speed Slow,Medium,Fast
    faerie_speed Slow,Medium,Fast
  • See src/control.cpp for individual command details.

Status LEDs ๐Ÿšฅ

The two RGB LEDs on both the M4 and ESP32 boards will display:

  • ๐Ÿ’š green: Bootloader active (M4 only) (double tap Reset to activate)
  • ๐Ÿงก orange: WiFi disconnected, connecting
  • ๐Ÿ’œ purple: MQTT disconnected, connecting
  • ๐Ÿ’™ cyan: Sending MQTT message
  • ๐Ÿ›‘ red: Unknown error

๐Ÿ”Œ The large green LED on the board with the INA219 indicates power, behind main capacitors.

cryptid-bottles's People

Contributors

reiniiriarios avatar vulcu avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.