Dmitry Shalnoff's Git Repository - Serial_RGB_Controller/blob - README.md

   1 # Serial RGB LED driver, Interplay Medium dendrite module (for ESP8266)
   2
   3 This is IM denrite module (remote wifi network device) created for [Interplay Medium™](https://interplaymedium.org) project.
   4
   5 ![Interplay Medium RGB Serial LED Dendrite](https://repository.interplaymedium.org/RGBW%20Controller/IM_RGBW_LED_dendrite.jpeg)
   6
   7 ## Pinouts
   8
   9 For LEDs be sure to add MOSFETs and current limiting resistors appropriately. Wiring scheme will be added probably later.
  10
  11 ![ESP8266 Pinout](https://repository.interplaymedium.org/RGBW%20Controller/esppinout_.png)
  12 ![ESP8266 Programming](https://repository.interplaymedium.org/RGBW%20Controller/usbprogram_.png)
  13
  14 ## Preparing the building environment
  15
  16 Make sure that you have the environment installed as described at
  17
  18 1. [makeEspArduino.mk](https://github.com/plerup/makeEspArduino.git)
  19 2. [esp8266 Arduino SDK](https://github.com/esp8266/Arduino)
  20
  21 3. In the *make* script, change path for each variable approprately:
  22     MAKE_FILE=....
  23     ESP_SDK_ROOT=....
  24
  25 ## Change your IM AXOD microserver or AP (router) WIFI login and password
  26
  27 create the file
  28     vim ../info
  29
  30 assign SSID and PASSWORD of your local IM AXOD microserver or Access Point in there
  31
  32     WIFI_SSID="ssid"
  33     WIFI_PASS="ssid password"
  34
  35 You can change it later whenewer you want using HTTP interface
  36
  37 ## Building
  38
  39 initial buildong and flashing firmware at once
  40
  41     ./make Serial_RGB upload
  42
  43 after that you may just build the binary and uload it using remote HTTP interface
  44
  45     ./make Serial_RGB
  46     curl -F image=@Serial_RGB.bin -s im_<....>.lan/update
  47
  48 ## Usage
  49
  50
  51 By default dendrite can be reached "im_serial_[last 4 digits of MAC address]" doman
  52
  53 Change it with
  54
  55     curl "im_serial_[last 4 digits of MAC address]?rename=NEWNAME"
  56
  57 Turn on the color and effect
  58
  59     curl "im_serial_[last 4 digits of MAC address]?gradient=ffffffccff44&slidez=-1&delay=100"
  60
  61 Other options
  62
  63     curl "im_serial_[last 4 digits of MAC address]/help"
  64
  65 ## Todo
  66
  67 The development of this firmware is in progress. Here is a brief list of upcoming changes:
  68
  69 * features (save, reset....)
  70 * state return in 2 variants
  71     txt (default)
  72     JSON
  73     html UI
  74 * add commands
  75     dimm and soft state changing
  76     rgbwdef -- save default values in EEPROM, which is returning on reset command
  77
  78 * switching AP/slave, AP by defuault
  79     remote access setup (host name, AP/slave, SSID, passw)
  80     save in EEPROM
  81
  82 ## License
  83
  84 Copyright © 2016 Dmitry Shalnov [interplaymedium.org]
  85
  86 Licensed under the Apache License, Version 2.0 (the "License");
  87 you may not use this files except in compliance with the License.
  88 You may obtain a copy of the License at
  89
  90     http://www.apache.org/licenses/LICENSE-2.0
  91
  92 Unless required by applicable law or agreed to in writing, software
  93 distributed under the License is distributed on an "AS IS" BASIS,
  94 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  95 See the License for the specific language governing permissions and
  96 limitations under the License.
  97
  98
  99
 100
 101
 102