]> git.donarmstrong.com Git - tmk_firmware.git/blobdiff - keyboard/hhkb_rn42/MEMO.txt
Update MEMO.txt
[tmk_firmware.git] / keyboard / hhkb_rn42 / MEMO.txt
index 87907e95f571f4d93f2edd29a6632b8e938041cb..02cd2e1883bdf6ae7203a6d5731b79f66dcd8737 100644 (file)
@@ -1,61 +1,82 @@
 Roving RN-42
 ============
 
-
 TODO
 ----
-- Lipo charger configuration: fast charge time
-- Low voltage alarm: LED indcates voltage of Lipo
-- CTS/RTS lines are needed? just connect in loop back if no flow control is needed.
-- CTS is needed for waking up from deep sleep?
-- Serial API callback  when data are available/received(and when send buffer is available)
-- Serial API instance  several serial ports can be used
+Power saving:
+- When not connected in a few minuts get into deep sleep to save battery life
+- CTS is needed for waking up from deep sleep? How deep sleep is activated?
+
+Improving:
+- Status LED; connecting, liked, low battery, sleeping, deep sleeping
+- Battry voltage display by command; like full(solid), medium(blink), low(flash)
+- move rn42 to protocol directory when it becomes reusable stack
+- LUFA sendchar should be buffered and serial_uart.c buffur size is too large(256).
+
+Testing:
+- Factroy reset doesn't work; need to **test again** 10K pull-up is too high?
+- Lipo voltage ADC value is not stabilized
+- DCDC converter: squeaky inducter; try other inductors
+
+- Keymap layer bug: during space is pressed(mousekey) press Fn(HHKB) then release space before Fn, in result HHKB layer is locked(toggled) unintentionally.
+
 
 DONE:
+- Lipo charger configuration: fast charge time:  USB charger spec? -- used 2kohm
+- use LED of charger to alarm low battery. LED should be powered directly from Lipo? - cancel; powered from VUSB
+- Use RTS in serial_uart.c to resolve missing chars from help message of RN-42 - done
+- CTS/RTS lines are needed? just connect in loop back if no flow control is needed. - done
+- add IO pin to charger status CHRG; LED control(low) and detect charge status(input HiZ) 07.24
+- LINKED: add trace on PIO2 to PF6   07.24
+- Lipo voltage ADC sensing
+- Lipo charger MCP73831: needs capacitor 4.7uF *2
 - USB connection check - 07.01
 - BT on/off check: whether RX line is pulled up? - checking RTS 07.01
 - USB/BT switching  BT is on -> BT, BT is off -> USB - 07.01
 - Under voltage lock out UVLO for protection of Lipo - Lipo has discharge protection at 3.100V    07.01
 - Power saving: HHKB scan, BT radio control - 9h with 850mAh, this is enough   07.01
+- Power selector doesn't work; Q4 MOSFET leaks from Lipo to USB power line. -- use Schottky instead 07/04
+
+
+
+TROUBLE SHOOT
+-------------
+07/16   After fix of voltage dividor on GPIO6, had a trouble that it could not send a char to BT module, though could receive.
+        Found R8 had wrong 1K resistor and changed to 10K, after that it can send to the module again. Not sure how it had sent with the wrong 1K before.
+
+07/18   On Linux, had an USB related trouble; keyobard or console didn't work for some reason. Changing PID cured this problem. Very annoying, took very long time before resolved it.
+
+
+
+Lipo
+----
+850mA lasts around 9 hours(07/28)
+
+Sparkfun Polymer Lithium Ion Battery 850mAh:
+https://www.sparkfun.com/products/341
+Lipo Cell spec:
+https://www.sparkfun.com/datasheets/Batteries/063048%20Li-polymer.pdf
+Protection spec:
+http://dlnmh9ip6v2uc.cloudfront.net/datasheets/Prototyping/BatteryProtection.pdf
+                                min     typical max
+    over-charge                 4.255   4.280   4.305
+    over-charge discover?       4.030   4.080   4.130        
+    over-discharge              2.827   2.900   2.973
+    over-discharge discover     3.022   3.100   3.178
 
+ADC voltage monitor:    voltage divider 10K+10K(0.5)
+                        ADC=V*0.5/2.56*1024
+
+    V       ADC
+    ------------------
+    4.20    0x347(839)
+    3.10    0x26b(619)
+    
 
 
 
 Configuration
 -------------
-Ver 6.15 04/26/2013
-(c) Roving Networks
-***Settings***
-BTA=0006664B3AE3
-BTName=tmkBT-3AE3
-Baudrt(SW4)=115K
-Mode  =Pair
-Authen=2
-Bonded=1
-Rem=001BDC06415B
-***ADVANCED Settings***
-SrvName= keyboard/mouse
-SrvClass=0000
-DevClass=05C0
-InqWindw=0100
-PagWindw=0100
-CfgTimer=255
-StatuStr=NULL
-HidFlags=3f
-DTRtimer=8
-KeySwapr=0
-***OTHER Settings***
-Profile= HID
-CfgChar= $
-SniffEna=0
-LowPower=0
-TX Power=4
-IOPorts= 0
-IOValues=0
-Sleeptmr=0
-DebugMod=0
-RoleSwch=0
-
 Ver 6.15 04/26/2013
 (c) Roving Networks
 ***Settings***
@@ -65,7 +86,7 @@ Baudrt(SW4)=115K
 Mode  =DTR
 Authen=2
 Bonded=0
-Rem=BCF5AC9BCB7E
+Rem=000000000000
 ***ADVANCED Settings***
 SrvName= keyboard/mouse
 SrvClass=0000
@@ -74,15 +95,15 @@ InqWindw=0100
 PagWindw=0100
 CfgTimer=255
 StatuStr=NULL
-HidFlags=3f
+HidFlags=3c
 DTRtimer=8
 KeySwapr=0
 ***OTHER Settings***
 Profile= HID
 CfgChar= $
-SniffEna=0
+SniffEna=8010
 LowPower=0
-TX Power=ffe8
+TX Power=0
 IOPorts= 0
 IOValues=0
 Sleeptmr=0
@@ -90,27 +111,38 @@ DebugMod=0
 RoleSwch=0
 
 
-command mode
-------------
-To enter command mode disconnect the module from host and type '$$$'.(you will see 'CMD')
-To exit type '---'.(you will see 'END')
 
+Serial connection
+-----------------
 Serial line:    115200bps, 8bit, 1-stopbit, non-parity, no flow control
 SSP:            115200bps, 8bit, 1-stopbit, non-parity, no flow control(via Bluetooth)
 
+To enter command mode disconnect the module from host and type '$$$'.(you will see 'CMD')
+To exit type '---'(you will see 'END') and '+' to get local echo.
+
+
+
+Setting command mode
+--------------------
+S-,tmkBT            // Device name
+SS,keyboard/mouse   // service name
+SM,4                // Auto Connect DTR mode
+SW,8010             // Sniff enable 0x10*0.625ms=10ms; 50ms is laggish and not much power save
+S~,6                // HID profile
+SH,003C             // HID register
+SY,0004             // Transmit power
+
+
 
-S-,tmkBT        // Device name
-SH,0038         // HID register
+
+Other options:
 SC,0000         // COD: 000005C0    (see HID spec/Bluegiga doc)
 SD,05C0         //     bit 12-8         7           6           5-0
                 //         00101        1           1           0
                 //         peripheral   pointing    keybaord    joystick, gamepad, ...
-S~,6            // HID profile
-SS,keyboard/mouse   // service name
 SM,6                // Pairing mode: auto connect
 SM,4                // Master mode: Connection can be controled with GPIO6
 
-SY,FEE8             // lower power -20dbM
 
 
 
@@ -123,7 +155,9 @@ R,1     reboot
 
 Apple iOS
 ---------
-Cannot supported without apple iAP authentication chip.
+Keyboard can be used with iPhone, but mouse cannot.
+To operate iOS with keyboard is not so useful, though.
+There may be iOS specific scancodes?
 
 
 HID flag register
@@ -147,6 +181,7 @@ GH
     0100:   Joystick
     1xxx:   reserved
 
+
 Out report - Indicator
 ----------------------
 0xFE 0x02 0x01 <LED_state>
@@ -192,7 +227,7 @@ Sniff mode                  Transmit
 
 Deep sleep                  Idle            (3.1.2)
     In this mode the module shuts down completly and only draws about 300uA. To enable this set the most signifant bit(0x8000) of Sniff interaval timer.
-    SW,8320     // deep sleep enable(interval=0x320*0.625ms)
+    SW,8320     // deep sleep enable(interval=0x320*0.625=500ms)
     In normal sleep the firmware is still running in idle mode, and wakes up about 20 times per second to check ports, update LEDs, etc. During deep sleep, the firmware actually stops runnig some tasks and the LEDs only update about once per second.
     To wake from deep sleep there are three ways: (in worst case wake up takes 5ms)
         *send a charactor to the UART(first charactor will be lost)
@@ -292,3 +327,65 @@ U,<baud>,<parity>       change UART setting tentatively
 V                       display firmware version
 W                       wake from quiet mode    enable discovery and connection
 Z                       deep sleep mode(<2mA)
+
+
+
+help
+----
+*** SET COMMANDS ***
+SA,<3,0>   - Authentication
+SC,<hex>   - Service Class
+SD,<hex>   - Device Class
+SE,<1-16>  - UUID
+SF,1       - Factory Defaults
+SH,<hex>   - HID flags
+SI,<hex>   - Inquiry Scan Window
+SJ,<hex>   - Page Scan Window
+SL,<E,O,N> - Parity
+SM,<0-5>   - Mode (0=slav,1=mstr,2=trig,3=auto,4=DTR,5=Any)
+SN,<name>  - Name
+SO,<text>  - conn/discon Status
+SP,<text>  - Pin Code
+SR,<adr>   - Remote Address
+SS,<text>  - Service Name
+ST,<num>   - Config Timer
+SU,<rate>  - Baudrate
+SW,<hex>   - Sniff Rate
+SX,<1,0>   - Bonding
+SY,<hex>   - TX power
+SZ,<num>   - Raw Baudrate
+S~,<0-6>   - Profile (0=SPP,1=DCE,2=DTE,3=MDM,4=D&S,6=HID
+S?,<0-1>   - role switch
+S$,<char>  - CMD mode char
+S@,<hex>   - io port dir
+S&,<hex>   - io port val
+S%,<hex>   - io boot dir
+S^,<hex>   - io boot val
+S*,<hex>   - pio(8-11) set
+S|,<hex>   - low power timers
+S+,<num>   - DTR timer
+S=,<hex>   - Key mapper
+S:,<num>   - sleep timer
+*** DISPLAY      ***
+D     - Basic Settings
+E     - Extended Settings
+G<X>  - Stored setting
+GB    - BT Address
+GF    - BT Address of Last Connection
+GK    - Connect Status
+G&    - I/O Ports
+V     - Firmare version
+*** OTHER        ***
+C,<adr>    - Connect
+F,1        - Fast Mode
+I,<time>,<cod> - Device Scan Inquiry
+J          - Hide Pin Code
+K,         - Kill (disconnect)
+L,         - toggle local echo
+P,<text>   - Pass Thru
+Q          - Quiet (no discovery)
+R,1        - Reboot
+T,<0,1>    - send data in CMD mode
+U,<rate>,<E,O,N> - Temp Uart Change
+Z          - low power sleep
+&          - Read switches