Update readme

botamochi6277 · Feb 6, 2024 · a30a4c9 · a30a4c9
1 parent 435244d
commit a30a4c9
Showing 1 changed file with 23 additions and 101 deletions.
diff --git a/README.md b/README.md
@@ -4,18 +4,18 @@
 
 Control NeoPixel-strip with [Seeeduino XIAO BLE](https://wiki.seeedstudio.com/XIAO_BLE/)/[M5Stack Atom Lite](https://docs.m5stack.com/en/core/atom_lite)
 
-You can change the lighting mode with BLE.
+You can change the lighting config with BLE. The lighting config has three parameters: `input_src_id`, `intensity_func_id`, and `colormap_id`.
 
 ```mermaid
 graph LR
 
 subgraph BLE Service
-  data_src_id
+  input_src_id
   intensity_func_id
   colormap_id
 end
 
-data_src_id-.->|select|sensor
+input_src_id-.->|select|sensor
 colormap_id-.->|select|colormap
 intensity_func_id-.->|select|intensity_func
 
@@ -24,104 +24,26 @@ sensor-->|value|intensity_func-->|intensity|colormap-->|color|pixel_manager-->ne
 ```
 
 
-## lighting mode
-You can choice a lighting mode in the follows.
-
-
-- Periodic: pixel colors change depending on elapsed time. 
-- Responsive: pixel colors change depending on sensor values.
-
-## ColorMap
-
-You can select colormap according to lighting mode.
-
-+ Cyclic colormap: for cyclic value. e.g. phase and orientation angle
-+ Sequential colormap: for unsigned sensor value. e.g. magnitude of acc
-+ Diverging colormap: for signed value. e.g. angular velocity
-
-
-- Colormap
-- Intensity Function
-- Arg of the intensity Function
-
-## Service Profile
-
-```yml
----
-name: "NeopixelService"
-uuid: "19B10000-E8F2-537E-4F6C-D104768A1214"
-characteristics:
-  - name: "timer_chr"
-    uuid: "19B10001-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedLong"
-    properties:
-      - "Read"
-      - "Notify"
-  - name: "imu_available_chr"
-    uuid: "19B10002-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-  - name: "num_pixels_chr"
-    uuid: "19B10011-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-  - name: "brightness_chr"
-    uuid: "19B10012-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "num_colors_chr"
-    uuid: "19B10021-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "color01_chr"
-    uuid: "19B10022-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedInt"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "color02_chr"
-    uuid: "19B10023-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedInt"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "color03_chr"
-    uuid: "19B10024-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedInt"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "color04_chr"
-    uuid: "19B10025-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedInt"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "colormap_chr"
-    uuid: "19B10026-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "lighting_mode_chr"
-    uuid: "19B10028-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-      - "Write"
-  - name: "transition_chr"
-    uuid: "19B10027-E8F2-537E-4F6C-D104768A1214"
-    data_type: "UnsignedChar"
-    properties:
-      - "Read"
-      - "Write"
-```
+## Lightning Config
+
+### Inputs
+- Time
+- Accel X/Y/Z
+- Gyro X/Y/Z
+
+### Intensity Functions
+- Heat (Linear)
+- Wipe
+- Traveling Wave
+- etc.
+
+### ColorMaps
+- Hsv
+- Twilight
+- TwilightShifted
+- etc.
+
+
 
 ## Add XIAO BLE to PlatformIO