de6e2d1bae13ecef09b191810c9f9219df69392c
[4_Channel_Switcher] / README.md
1 # 4 Channel Switcher / LED stripe controller, 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 4 Channel Switcher Dendrite](https://repository.interplaymedium.org/4_Channel_Switcher/IMG_2191.jpg)
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 building and flashing firmware at once 
40  
41     ./make 4_Channel_Switcher upload
42
43 after that you can build the binary and uload it using remote HTTP interface
44
45     ./make 4_Channel_Switcher  
46     curl im_switch_MACLAST4DIGITS/update -F image=@4_Channel_Switcher.bin
47
48 ## Usage 
49
50 By default dendrite unit can be reached on "`im_switch_[last 4 digits of MAC address]`" 
51
52 Change the name of unit by
53
54     curl im_switch_[last 4 digits of MAC address]?host=NEWNAME
55
56 Turn on each even switches 
57
58     curl im_switch_[last 4 digits of MAC address]?switch=0101
59
60 Other options
61
62     curl im_switch_MACLAST4DIGITS/help
63
64 ## Todo 
65
66 The development of this firmware is in progress. Here is a brief list of upcoming changes: 
67
68 * add interface features (save, reset....)
69 * state return in 2 variants  
70     txt (default)  
71     JSON  
72     http UI  
73 * add commands  
74     dimm and soft state changing  
75     rgbwdef -- save default values in EEPROM, which is returning on reset command  
76   
77 * switching AP/slave, AP by defuault
78     remote access setup (host name, AP/slave, SSID, passw)  
79     save in EEPROM  
80
81 ## License
82
83 Copyright © 2016 Dmitry Shalnov [interplaymedium.org]
84
85 Licensed under the Apache License, Version 2.0 (the "License");
86 you may not use this files except in compliance with the License.
87 You may obtain a copy of the License at
88
89     http://www.apache.org/licenses/LICENSE-2.0
90
91 Unless required by applicable law or agreed to in writing, software
92 distributed under the License is distributed on an "AS IS" BASIS,
93 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
94 See the License for the specific language governing permissions and
95 limitations under the License.
96
97
Contact me: dev (at) shalnoff (dot) com
PGP fingerprint: A6B8 3B23 6013 F18A 0C71 198B 83D8 C64D 917A 5717