Giter Site home page Giter Site logo

mood-bottle's Introduction

moodBottle (V1.0.0)

Built and maintained by Imogen Wren

Features

  • Bar/Mood light designed to control WS2812B Addressable LEDs for a feature ornament.
  • Slow to Medium colour blending to create an effect that is visually stimulating without being too distracting.
  • Great for background light for a bar or nightclub.
  • A modern take on an 80s lava lamp with a far wider range and mixes of colours
  • Colour Palettes hand picked for a mix of high impact and low impact effects
    • 2 Major modes: colour_palettes: High Impact Palettes, and planet_palettes: Low impact mode
  • Optimised for short WS2821B LED strings. All effects designed and optimized for just 8 LEDs! (But use as many as you wish)

Effects Modes

colour_palettes

Colour palettes were designed around some of my favourite colour combinations. They replicate well known plasma effects, but by ristricting palettes to two or three shades, it creates a more random overall feeling than a constantly cycling rainbow effect. Don't worry though, for people who love the "RGB Rainbow" effect, several palettes are included which navigate the entire colour spectrum as well as a procedurally generated random palette.

All palettes in colour_palette mode are selected randomly using a random number generator.

planet_palettes

Planet palettes are designed to be more subtle colour effects, based on a virtual tour of the major bodies of the Sol System.


This mode is triggered every 10 minutes, instead of randomly selecting palettes, our voyage starts in a heliocentric orbit around our star: **Sol** . Its bright yellow and orange, ocasionally pierced by a bright white light, aims to reflect the feeling of gazing upon The Sun in space, harsh and unforgiving.


From here we travel to **Mercury** , its reddish browns, oranges and yellows reflect its surface hot enough to melt tin, but it still makes a welcome break from the harsh light before this.


On to **Venus** , the Oranges get more orange, the yellows become a toxic sulphurous cloud, and some pastel white clouds start swirling. The planets surface might kill you instantly, but it sure is pretty to look at from orbit.


Our next stop is our mother world: **Earth** . Here we are welcomed by the familiar blues and turquoise of our home seas, the deep and lucious greens of our rainforests, the dirty yellows of the sahara as seen from space, and the white whisps of clouds over the sea. Watch out for a brief fly-past **The Moon** on our way out towards the outer planets.


We leave the comfort of home, and fly to a far less forgiving world, **Mars** : The Red Planet. Although this palette is far less red than one might expect. It was based on a mix between our impressions of Mars from a distance, and photos taken by our army of robots on the red planet's surface and in orbit. Browns, dark yellows and just a touch of white to reflect the frozen CO2 of the polar caps.


After our brief stops at each of the inner planets of the solar system, we pass the first of the gas giants, **Jupiter** . Its swirling white, orange, and yellow storms are peirced by a short flash of deep red, the biggest storm of the solar system and Jupiters most defining feature.


Following in the footsteps of Voyager 2, we continue our tour of all the gas-giants. We arrive at **Saturn** , the brighter oranges of Jupiter are replaced with more subtle yellows and browns. Unlike Cassini, our journey does not end in the atmospheric clouds of Saturn, but on we continue...


To the blue methane worlds of **Neptune** & **Uranius** , both morphing between turquoise and deep blues, with the occasional white clouds and storms.


Finally we arrive at **Pluto** , this palette is based upon the false-colour images of Pluto's icy surface generated from images taken by the New Horizons spacecraft. Different types of ice are highlighted in whites, blues, reds and greys.

With our Voyage complete, we leave the solar system and our horizon fades to black, the program reverts to colour_palettes mode.




Getting Started

Software Requirements

Hardware Requirements

  • Arduino compatable board:
    • Arduino Uno/Nano or ESP32 reccommended
  • WS2812B Addressable LEDs
  • 100r Resistor between data LED_PIN and Data In (DI) on LED strip
  • 1000uF capacitor reccomended between 5v & GND for LED strip power supply
  • WARNING: Each WS2812B LED can draw up to 60 mA.
    • Calculate total current draw for your strip and use a suitable power supply.

Deployment

  1. Clone or Download folder into Arduino IDE projects folder
  2. Extract files from zipped folder if required.
  3. Open moodBottle.ino in Arduino IDE.
  4. Upload sketch to compatable Arduino board (Tested on Arduino Uno & Arduino Nano)

User Options:

Program contains some settings that can be easily edited to change the program flow. Detailed below.

In moodBottle.ini File

Select the data pin for WS2812B
#define LED_PIN 5

Specify number of LEDs in WS2812B strip
#define NUM_LEDS 8

Define the maximum brightness for all effects values from 0 - 255 are valid. (N.B. Changing this setting will effect the colour balance of some effects)

#define BRIGHTNESS 255

These settings may need changing depending on the LED strip used. Consult manufacturer and/or FastLED documentation for valid settings.

#define LED_TYPE WS2811
#define COLOR_ORDER GRB

Settings that control overall timing of animations:

Set framerate, Reccomended between 25 & 60 fps.

#define UPDATES_PER_SECOND 30

Define the number of steps each palette cycles through the hues between each LED in the strip.
We feel that 5 is a good balance between an interesting effect that doesn't feel too manic.

#define HUE_STEPS 5

When true it overwrites switching, only outputs solar system mode

#define SOLAR_SYSTEM false

If Set false, colours are painted in a single direction only. If true, direction changes at random periods.

#define RANDOMISE_DIRECTION true

Pick any named Palette as the start palette on system power up or reset.
#define START_PALETTE white_light

Alternative option for picking a totally random colour_palette for start palette.
//#define START_PALETTE select_palette(random(0, NUM_FX));

Debug Variables. Easily switch debug outputs on and off.

#define PRINT_INDEX false
#define DEBUG_DELAY false
#define DEBUG_DELAY_TIME 300

Fade to black constants. Used for planet_palettes.

#define FADE_THROUGH_DELAY 1 // delay time between brightness changes during crossfade through black effect (millis)
#define PAUSE_BLACK_DELAY 100 // delay time to pause at black between crossfade for cleaner scene change effect

Define the number of minutes between triggering planet_palette mode.

#define PROGRAM_DELAY 10


________________________________________________________________________________________________________



Limitations:


Known Issues V1.0.0

  • Please report any bugs or issues found.

Features to be Added



About

Built With

Author

Imogen Wren

mood-bottle's People

Contributors

imogenwren avatar

Stargazers

 avatar

Watchers

James Cloos 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.