summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2023-05-22 13:40:34 +1000
committerGitHub <noreply@github.com>2023-05-22 04:40:34 +0100
commit595f7db3840ab8155264e948d8ad5be5f8a1d0ed (patch)
treec60dcc122ed89fc69eb15909ab3113fd9b817751
parent36b08d5d693b74c997a6889960d7379b44fc79b9 (diff)
Remove HHKB RN42 code (#21007)
-rw-r--r--keyboards/hhkb/ansi/config.h29
-rw-r--r--keyboards/hhkb/ansi/post_rules.mk18
-rw-r--r--keyboards/hhkb/ansi/rules.mk9
-rw-r--r--keyboards/hhkb/jp/config.h29
-rw-r--r--keyboards/hhkb/jp/post_rules.mk18
-rw-r--r--keyboards/hhkb/jp/rules.mk9
-rw-r--r--keyboards/hhkb/rn42/MEMO.txt262
-rw-r--r--keyboards/hhkb/rn42/PowerSave.txt88
-rw-r--r--keyboards/hhkb/rn42/RN42.txt408
-rw-r--r--keyboards/hhkb/rn42/battery.c130
-rw-r--r--keyboards/hhkb/rn42/battery.h32
-rw-r--r--keyboards/hhkb/rn42/main.c106
-rw-r--r--keyboards/hhkb/rn42/rn42.c253
-rw-r--r--keyboards/hhkb/rn42/rn42.h27
-rw-r--r--keyboards/hhkb/rn42/rn42_task.c467
-rw-r--r--keyboards/hhkb/rn42/rn42_task.h11
-rw-r--r--keyboards/hhkb/rn42/suart.S156
-rw-r--r--keyboards/hhkb/rn42/suart.h5
-rw-r--r--keyboards/hhkb/serial.h46
-rw-r--r--keyboards/hhkb/serial_uart.c133
-rw-r--r--keyboards/hhkb/yang/config.h34
21 files changed, 0 insertions, 2270 deletions
diff --git a/keyboards/hhkb/ansi/config.h b/keyboards/hhkb/ansi/config.h
index 306b1df200..723fe29479 100644
--- a/keyboards/hhkb/ansi/config.h
+++ b/keyboards/hhkb/ansi/config.h
@@ -24,35 +24,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define TAPPING_TERM 200
-#ifdef HHKB_RN42_ENABLE
-// rn42 support -- acquired from the tmk repo. This is almost certainly not
-// integrated with qmk in the correct way.
-
-#define SUART_OUT_PORT PORTD
-#define SUART_OUT_BIT 0
-#define SUART_IN_PIN PIND
-#define SUART_IN_BIT 1
-
-#define SERIAL_UART_BAUD 115200
-#define SERIAL_UART_INIT_CUSTOM \
- /* RX interrupt, RX: enable */ \
- UCSR1B |= (1<<RXCIE1) | (1<<RXEN1); \
- /* TX interrupt, TX: enable */ \
- UCSR1B |= (0<<TXCIE1) | (1<<TXEN1); \
- /* parity: none(00), even(01), odd(11) */ \
- UCSR1C |= (0<<UPM11) | (0<<UPM10); \
- /* RTS, CTS(no flow control by hardware) */ \
- UCSR1D |= (0<<RTSEN) | (0<<CTSEN); \
- /* RTS for flow control by firmware */ \
- DDRD |= (1<<5); PORTD &= ~(1<<5);
-#define SERIAL_UART_RTS_LO() do { PORTD &= ~(1<<5); } while (0)
-#define SERIAL_UART_RTS_HI() do { PORTD |= (1<<5); } while (0)
-
-/* power control of key switch board */
-#define HHKB_POWER_SAVING
-
-#endif
-
/*
* Feature disable options
* These options are also useful to firmware size reduction.
diff --git a/keyboards/hhkb/ansi/post_rules.mk b/keyboards/hhkb/ansi/post_rules.mk
deleted file mode 100644
index eb9a8f0adb..0000000000
--- a/keyboards/hhkb/ansi/post_rules.mk
+++ /dev/null
@@ -1,18 +0,0 @@
-ifeq ($(strip $(HHKB_RN42_ENABLE)), yes)
-
-OPT_DEFS += -DHHKB_RN42_ENABLE
-
-# Support for the RN42 Bluetooth module. This is the BT module in Hasu's BT
-# HHKB Alt controller.
-RN42_DIR = keyboards/hhkb/rn42
-
-SRC += serial_uart.c \
- suart.S \
- rn42.c \
- rn42_task.c \
- battery.c \
- main.c
-
-VPATH += $(RN42_DIR)
-
-endif
diff --git a/keyboards/hhkb/ansi/rules.mk b/keyboards/hhkb/ansi/rules.mk
index efe5ab4456..f5a147ccb9 100644
--- a/keyboards/hhkb/ansi/rules.mk
+++ b/keyboards/hhkb/ansi/rules.mk
@@ -10,15 +10,6 @@ CUSTOM_MATRIX = yes # Custom matrix file for the HHKB
NKRO_ENABLE = no # Enable N-Key Rollover
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
-HHKB_RN42_ENABLE = no # Enable support for hasu's BT alt controller -- code borrowed from tmk source tree.
-
-# Either uncomment the HHKB_RN42_ENABLE line above, or run make enabling the
-# feature. Be sure to clean any existing build before trying to enable rn42
-# support. For example:
-#
-# make hhkb-keymap-clean
-# make hhkb-keymap-dfu HHKB_RN42_ENABLE=yes
-
# project specific files
SRC = matrix.c
diff --git a/keyboards/hhkb/jp/config.h b/keyboards/hhkb/jp/config.h
index 4ab0c5058c..9de64724b7 100644
--- a/keyboards/hhkb/jp/config.h
+++ b/keyboards/hhkb/jp/config.h
@@ -24,35 +24,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define TAPPING_TERM 200
-#ifdef HHKB_RN42_ENABLE
-// rn42 support -- acquired from the tmk repo. This is almost certainly not
-// integrated with qmk in the correct way.
-
-#define SUART_OUT_PORT PORTD
-#define SUART_OUT_BIT 0
-#define SUART_IN_PIN PIND
-#define SUART_IN_BIT 1
-
-#define SERIAL_UART_BAUD 115200
-#define SERIAL_UART_INIT_CUSTOM \
- /* RX interrupt, RX: enable */ \
- UCSR1B |= (1<<RXCIE1) | (1<<RXEN1); \
- /* TX interrupt, TX: enable */ \
- UCSR1B |= (0<<TXCIE1) | (1<<TXEN1); \
- /* parity: none(00), even(01), odd(11) */ \
- UCSR1C |= (0<<UPM11) | (0<<UPM10); \
- /* RTS, CTS(no flow control by hardware) */ \
- UCSR1D |= (0<<RTSEN) | (0<<CTSEN); \
- /* RTS for flow control by firmware */ \
- DDRD |= (1<<5); PORTD &= ~(1<<5);
-#define SERIAL_UART_RTS_LO() do { PORTD &= ~(1<<5); } while (0)
-#define SERIAL_UART_RTS_HI() do { PORTD |= (1<<5); } while (0)
-
-/* power control of key switch board */
-#define HHKB_POWER_SAVING
-
-#endif
-
/*
* Feature disable options
* These options are also useful to firmware size reduction.
diff --git a/keyboards/hhkb/jp/post_rules.mk b/keyboards/hhkb/jp/post_rules.mk
deleted file mode 100644
index eb9a8f0adb..0000000000
--- a/keyboards/hhkb/jp/post_rules.mk
+++ /dev/null
@@ -1,18 +0,0 @@
-ifeq ($(strip $(HHKB_RN42_ENABLE)), yes)
-
-OPT_DEFS += -DHHKB_RN42_ENABLE
-
-# Support for the RN42 Bluetooth module. This is the BT module in Hasu's BT
-# HHKB Alt controller.
-RN42_DIR = keyboards/hhkb/rn42
-
-SRC += serial_uart.c \
- suart.S \
- rn42.c \
- rn42_task.c \
- battery.c \
- main.c
-
-VPATH += $(RN42_DIR)
-
-endif
diff --git a/keyboards/hhkb/jp/rules.mk b/keyboards/hhkb/jp/rules.mk
index 2979c855c7..5c65964341 100644
--- a/keyboards/hhkb/jp/rules.mk
+++ b/keyboards/hhkb/jp/rules.mk
@@ -10,15 +10,6 @@ CUSTOM_MATRIX = yes # Custom matrix file for the HHKB
NKRO_ENABLE = no # Enable N-Key Rollover
# BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
-# HHKB_RN42_ENABLE = yes # Enable support for hasu's BT alt controller -- code borrowed from tmk source tree.
-
-# Either uncomment the HHKB_RN42_ENABLE line above, or run make enabling the
-# feature. Be sure to clean any existing build before trying to enable rn42
-# support. For example:
-#
-# make hhkb-keymap-clean
-# make hhkb-keymap-dfu HHKB_RN42_ENABLE=yes
-
# project specific files
SRC = matrix.c
diff --git a/keyboards/hhkb/rn42/MEMO.txt b/keyboards/hhkb/rn42/MEMO.txt
deleted file mode 100644
index 0ad56c79cf..0000000000
--- a/keyboards/hhkb/rn42/MEMO.txt
+++ /dev/null
@@ -1,262 +0,0 @@
-Memo of deveopment
-==================
-just memo, NOT WORTH READING
-
-2015/11/24
-JP Bluetooth:
- RN-42 cannot send Japanese keys like; henkan, mu-henkan and kana, JPY and RO.
- It seems HID usage more than 0x65 cannot be send with the module.
- http://shiki.esrille.com/2014/07/bluetoothnisse.html
-
-
-Bug:
-- Factory Reset PIO4 doesn't work
- - the reason is unclear - 12/08 NOT LOOK INTO ANY MORE
- - WORKAROUND: use serial pins(3.3V, GND, RX and TX)
- - SF,1 and R,1 to set factory defalult
-
-
-Todo:
-- LED cover and switch knob and new Slide Switch
-- RN42 auto configuration
- - configure the module as HID device every time powering up
- - this'll reduce work load of assembly
-
-- move rn42 to protocol directory when it becomes reusable stack
-
-- sendchar() in lufa.c no buffer
- - no buffering. character lost can be caused.
-- LUFA sendchar should be buffered and serial_uart.c buffur size is too large(256).
-
-- BT operations
- - disconnect
- - new connection
- - remove connection
-
-- sendchar() in lufa.c block loop - DONE 11/29
- - block loop when powered with AC adapter
- - FrameNumber is not updated when adapter powered
-
-Improving:
-- ADC resolution
- AVR120
- AVR32138
- - Enhancing ADC resolution by oversampling
- AVR121 http://www.atmel.com/images/doc8003.pdf
- - disable digital input buffer DIDR(7.8.6)
-
-Design:
-- suspend.h - DONE 11/26
- - remove argument from suspend_power_down() for backward compatitibility
-- remove MCU dependent power saving code from core/keyboard - DONE 11/23
- - it should be located in project matrix.c
-- HHKB matrix.c needs matrix_prev?
- - is_modified() is obsolete now. really needs?
-- ADC: removing AREF capacitor C10
- - seems to be better while usb powered
- - still bad while battery powered
- http://electronics.stackexchange.com/questions/105849/avcc-and-capacitor-using-adc
-- ADC: smaller resistors for voltage dividor
- - 1K + 1K: not improved. - 11/27
-
-
-LUFA:
-USB connection check: state of USB deivce
-- USB_DeviceState:
- USB_Deivce_State_t { Unattached, Powered, Default, Addressed, Configured*, Suspended* }
- Unattached: unpluged
- Powered: pluged with power adapter
- Default: enumerate process bigin
- Addressed: addressed
- Configured: enumerated
- Suspended: suspended
-
-- USB_IsInitialized: state of LUFA core setup
- becomes true in USB_Init() USBController_AVR8.c
- becomes false in USB_Disable() USBController_AVR8.c
-- USB_VBUS_GetStatus(): state of VBUS(power/connection)
-- USB_Disable() detaches, disables all interrupts, controller, PLL, regulater.
-
-- When connect to power adapter
- - event happened: CW or CSW or C or DDC
- - USB state: not configured
-
-- USB evnets
- - USB connect: CSWRWRW
- - USB connect but fail to enumeration: CWRWRWRWS
- - USB disconnect: D
- - Power adapter connect: CW, CSW, C
- - Power adapter disconnect: D
-
-
-Power saving:
-- Pro2 current consumption
- - active: 138.2mA(no device on Hub)
- - suspended: 30.9mA(WakeUp enabled DIPSW6)
- - suspended: 0mA->46.0mA(WakeUp disabled DIPSW6)
-- Pro current consumption
- - active: 54.0mA
- - suspended: 40.5mA(WakeUp enabled DIPSW6)
- - suspended: 0.3mA(WakeUp disabled DIPSW6)
-
-- RN42 3.3V
- - disconnected(Idle): 5mA (config mode)
- - connected(Active):
- SW,0000: 23-26mA
- SW,0010: 27-29mA worse than 0000 for unknown reason
- SW,0020: 17-19mA mouse NG
- SW,0030: 13-16mA laggy mouse NG
- SW,0050: 10-13mA laggy mouse NG
-
-- matrix power saving
- - power saving while externally powered and not while unpluged
-- confirm suspend mode lufa.c: matrix_power_*, suspend_wakeup_condition
-- 8MHz clock
-- When not connected in a few minutes get into deep sleep to save battery life
-- CTS is needed for waking up from deep sleep? How deep sleep is activated?
-- firmware controlled 3.3V DC converter to switch on/off BT module
-- sleep MCU and BT module(keyboard is not used)
-- deep sleep MCU and BT module(keyboard is not used for long time)
-- deep sleep MCU and turn off BT module(keyboard is not used and not connected)
-- Battery ADC; switching, high resistance
- - switching gnd end of divider with PF4
- - high resistor 100K/1M?
- capacitor 10nF
- http://www.eevblog.com/forum/beginners/measuring-battery-voltage-without-consuming-current/
-- During USB suspend change clock source to internal RC from external Xtal(6.8)
-- FRZCLK: you can freeze clock for power saving. still WAKEUPI and VBUSTI interrupts are available while freezing.(21.7.3)
-- Suspend: Clear Suspend Bit, Freeze clock, disable PLL, MCU sleep(21.13)
-- Voltage reference(8.1.1)
- - to reduce power consumption while power down mode
-- unset ADEN before sleep(24.7)
-
-
-
-
-
-
-
-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)
-
-
-
-
-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; keyboard or console didn't work for some reason. Changing PID cured this problem. Very annoying, took very long time before resolved it.
-
-12/07 rn42_rts() read 1 every time. R12 broke in open mode(no coductive), idk why, too much heat with soldering? and PF1 pin was not soldered.
- It resolved with resoldering PF1 and new resistor on R12.
-
-
-
-
-Done:
-- low battery alert(solid light) 09/04
-- *** Rev.E BT test *** - DONE
- - with MCP73832, new Schottky, tantalum caps - DONE 12/07
- * MCP73832 doesn't leak from Vcc pin when unpluged and battery powered
- 34mV vs 2.07V(MCP73831) at Vcc pin
- MCP73832 doesn't need revese protection diode D5
- * PMEG2010ER is very low VF while reverse current/voltage is high
- VF=0.96 vs 1.98(RB160M-30TR)with Fluke 175
- Anode of D11 is 680mV vs 20mV(RB160M-30TR)
- 780mV is still low < 1.4V VBUS plugin detection(21.11)
- this doesn't cause false VBUS detect
- and 780mV on MCP73832 Vcc pin is also no problem.
- D5 can be removed.
- - ADC divider switching - DONE 12/07
- * Drain and Source of Q4 Pch was reversed wrongly on Rev.E.
-
- - reverse current from Lipo charger - DONE 12/07
- * MCP73832 has no recverse current from Vcc pin unlike MCP73831
-
-
-- Rev.F design - DONE
- - current measure point - DONE 12/08
- - change value of cap 68->47 - DONE 12/08
- - PPTC land pattern: no solder jumper, use 0Ohm resistor instead - CANCEL 12/08
- - Q4 Pch FET: wrong Drain and Source - DONE 12/08
- - D5 can be removed. - DONE 12/08
-
-
-
-- BT_INDICATOR LED turns on wrongly when touching line or pin. -- pull-up enabled on PF6/GPIO2 08/30
-- 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
-
-- wrongly suspended when powered from adapter without USB connection - DONE
- - suspend event may occur when plug into adapter
- - and never wake until conected to real USB line
- - without debug print via USB no problem; CSW(wake just after suspend as real USB line)
- - seems like USB print causes this problem after suspended
-
-- lose USB connection during power-down mode - DONE
- - USB initialize code in main() causes this - WRONG
- - Do not power-down during USB connection is active - DONE 11/11
- (USB_DeviceState == USB_DEVICE_Configured) is used to check USB connection
- matrix_power_down() matrix.c - 11/23
-
-- with Nexus5 keyboard and mouse are very laggy.
- Not confirmed. 01/15
-
-- switch BT host connections - CANCEL 01/15
- - switch next connection
- cannot switch connection with version 6.15 at least
-
-- When given power only from wall wart adapter - DONE? not confirmed 01/15
- - it sleeps. it should not sleep
- - Configured state without USB connection?
-
-- timer is slow while power down - DONE 11/26
- - time out interrupt is lost while power down?
- - interrupt of watchdog timer compensates timer counter(avr/suspend.c)
-
-- repeated CHARGING/FULL_CHARGED - No longer problem 01/15
- - In LTC sharp pulses are observed.
- - MCP has no pulse but still has a problem.
- - needs more wait before read pin state? - NO
-
-- USB plug-in fails while BT - No longer problem 01/15
- - it ends in suspend state
- - maybe, not responsive to host enumeration process due to power-down.
- - matrix_power_down() only when state is unattached - 11/26
- - need to observe a while
-
diff --git a/keyboards/hhkb/rn42/PowerSave.txt b/keyboards/hhkb/rn42/PowerSave.txt
deleted file mode 100644
index 4b9c8f415d..0000000000
--- a/keyboards/hhkb/rn42/PowerSave.txt
+++ /dev/null
@@ -1,88 +0,0 @@
-Power Saving
-============
-
-
-MCU+HHKB Power Comsumption
---------------------------
-Battery drive:
- idle 18.9mA
- active 35.8mA
-
-USB powered:
- 40.0mA
- 52mA 01/17
-
-Other keyboards:
-HHKB Pro 55mA
-HHKB Pro2 140mA
-HHKB Pro 42mA(Alt)
-HHKB Pro2 52mA(Alt BT controller USB mode)
-HHKB Pro2 88mA(Alt BT controller BT mode connected)
-HHKB Pro2 68mA(Alt BT controller BT mode config mode)
-Poker X 6mA
-Infinity 24mA(TMK)
- 65mA(kiibohd)
-
-
-HHKB key switch power control
------------------------------
-MOS FET Nch: BSS138 or IRLML6344T, either works and no apparent difference.
-Normally on(pull-up) or off(pull-down)? interms of power saving it prefers pull-down?
-
-Pull-down will be better for power saving, normally off.
-
-
-
-Used Timer
-----------
-
-8MHz clock
-----------
-1) 16MHz xtal with system prescaler div2: F_CPU=8MHz, F_USB=16MHz
-2) 8MHz xtal with div1: F_CPU=8MHz, F_USB=8MHz
-Hardware USART doesn't work at 115200bps with 8MHz(F_CPU).
-
-workaround:
-a) use Sotwre serial for communcation with RN-42
-b) reduce baud of RN-42 to lower rate;(factory default is 115200bps)
-10/03
-
-
-
-Slave mode
-----------
-Discovery/Inquire
-Connect/Page
-
-SI,0012
-SJ,0012
-InqWindw=0100
-PagWindw=0100
-
-
-Sniff mode
-----------
-0.625ms * <hex>
-SW,0320 Very sluggish. Type is not lost but very slow to register.
-SW,0160 Still sluggish. may transposed? can type but ...
- Mouse point move intermittently
-SW,0020 feel a bit late like stumble(20ms)
-SW,0010 feel no latency(10ms)
-
-
-Deep sleep
-----------
-SW,8010
-
-
-TX power
---------
-SY,fff4
-
-
-IO pins
--------
-S%,1000 status led and connection control don't work
- GPIO5: status LED
- GPIO6: Connection control
- GPIO2: linked status
diff --git a/keyboards/hhkb/rn42/RN42.txt b/keyboards/hhkb/rn42/RN42.txt
deleted file mode 100644
index b30a0327d4..0000000000
--- a/keyboards/hhkb/rn42/RN42.txt
+++ /dev/null
@@ -1,408 +0,0 @@
-RN-42 Bluetooth Module Support
-==============================
-Bluetooth controller board works with HHKB Pro2, JP, Type-S and Type-S JP and it supports both USB and Bluetooth as keyboard output protocol. Bluetooth module Roving Networks/Microchip RN-42 is installed on the board.
-
-
-RN-42:
-http://www.microchip.com/wwwproducts/Devices.aspx?product=RN42
-
-
-Capabitlities:
-- USB keyboard functions
- completely equivarent to USB controller including mouse keys and NKRO.
-- Switching between USB and Bluetooth
- You can switch the two connections with BT switch or key combination.
-- RN-42 config mode
- You can change power/connection configuration of the module if needed.
-- Low battery alert
- Red LED turns on when low voltage.
-- RN-42 status indicator
- LED indicates status of Bluetooth connection.
-- Pairing
- The module stores up to 8 connections.
-- Auto connect
- The module connects the last connected device automatically.
-- iOS support
- works as keyboard with iPhone5. No tested completely.
-- Android support
- works as keyboard and mouse with Nexus5. No tested completely.
-- Mouse keys over BT
- Note that iOS doesn't accept mouse device.
-
-
-Limitations:
-- Short battery life
- Around 12hr with 1000mAh
-- No connection switching
- RN-42 auto-connects to the last connected device.
- Some of consumer products can switch between devices, for example Logitech K480.
- http://www.logitech.com/en-us/product/multi-device-keyboard-k480?crid=26
-- HHKB JP requires case modification for BT switch and LEDs.
- without switch power controlled by MCU? Probably using 3.3V regulator enable pin power of RN-42 can be controlled.
-
-NOTE:
-- LIPO BATTERY IS VERY DANGEROUS, TAKE EXTRA CARE OF YOUR SAFETY AND PROPERTY.
-- RN-42 version 6.15 is supported.
-- No NKRO over Bluetooth
-- Check you country's wiress regulation and certification of RN-42.
-
-Bugs:
-
-Todos:
-
-
-Lipo Battery
-------------
-You can use 3.7V Lithium Ion battery with JST PH 2pin connector and protection circuit.
-Battery space inside HHKB is around 54mm x 50mm and its height is 7mm.
-
-Sparkfun 850mAh
-https://www.sparkfun.com/products/341
-Sparkfun 1000mAh
-https://www.sparkfun.com/products/339
-
-Sparkfun 2000mAh battery won't fit due to its size.
-
-Learn about Lipo battery:
-https://learn.adafruit.com/li-ion-and-lipoly-batteries
-
-
-
-
-
-LED Status
-----------
-Configuring 10 times per sec
-Startup/configuration timer 2 times per sec
-Discoverable/Inquiring/Idle once per sec
-Connected solid on
-
-
-RN-42 Magic Command
---------------------
-Magic key combination is 'LShift+RShift' by default in case of HHKB.
-
-Here is help.
-
- ----- Bluetooth RN-42 Help -----
- i: RN-42 info
- b: battery voltage
- Del: enter/exit RN-42 config mode
- Slck: RN-42 initialize
- p: pairing
- u: toggle Force USB mode
-
- RN-42 info: displays information of the module on console.
- battery voltage: displays current voltage of battery and uptime.
- RN-42 initialize: does factory reset and configures RN-42
- pairing: enters Pairing mode.
- toggle Force USB mode: switch between USB and Bluetooth
-
-
-RN-42 Config mode
------------------
-You can tune/operate RN-42 yourself with config(command) mode.
-
-1. hook up USB cable
-2. run `hid_listen` command in console
-3. turn on Bluetooth switch
-4. press LShift+RShift+Delete(Fn+~) you will see output like followings:
-
- Entering config mode ...
- CMD
- v
- Ver 6.15 04/26/2013
- (c) Roving Networks
-
-5. do config with RN-42 commands. See documentations of RN-42.
-6. to exit also press LShift+RShift+Delete(Fn+~)
-
- Exiting config mode ...
- ---
- END
-
-
-RN-42 Initial Configuration
----------------------------
-RN-42 is configured as SPP device at factory reset, you need to configure it as HID device. This is needed just once first time.
-
-1. hook up USB cable
-2. run `hid_listen` command in console
-3. turn on Bluetooth switch
-4. press LShift+RShift+ScrLk(Fn+O) you will see output like followings:
-
- Entering config mode ...
- CMD
- Ver 6.15 04/26/2013
- (c) Roving Networks
- ECHO ON
- SF,1
- AOK
- S-,TmkBT
- AOK
- SS,Keyboard/Mouse
- AOK
- SM,4
- AOK
- SW,8000
- AOK
- S~,6
- AOK
- SH,003C
- AOK
- SY,FFF4
- AOK
- R,1
- Reboot!
- Exiting config mode ...
-
-5. output of command 'X' after cofiguration
-
- Ver 6.15 04/26/2013
- (c) Roving Networks
- ***Settings***
- BTA=00066667BBE9
- BTName=TmkBT-BBE9
- Baudrt(SW4)=115K
- Mode =DTR
- Authen=1
- PinCod=1234
- Bonded=0
- Rem=NONE SET
- ***ADVANCED Settings***
- SrvName= Keyboard/Mouse
- SrvClass=0000
- DevClass=1F00
- InqWindw=0100
- PagWindw=0100
- CfgTimer=255
- StatuStr=NULL
- HidFlags=3c
- DTRtimer=8
- KeySwapr=0
- ***OTHER Settings***
- Profile= HID
- CfgChar= $
- SniffEna=8000
- LowPower=0
- TX Power=fff4
- IOPorts= 0
- IOValues=0
- Sleeptmr=0
- DebugMod=0
- RoleSwch=0
-
-
-Switch to USB mode
-------------------
-You can switch between USB and Bluetooth with pressing 'LShift+RShift+u'.
-
-
-Pairing mode
-------------
-This disconnects current connect and enter pairing mode.
-
-
-
-
-For deveropment
-===============
-
-RN-42 Serial Connection
------------------------
-UART: 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') and type '+' to get local echo. To exit type '---'(you will see 'END').
-
-
-RN-42 Commands
---------------
-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
-S~,0 // SPP profile
-SH,003C // HID register
-SY,0004 // Transmit power
-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, ...
-SM,6 // Pairing mode: auto connect
-SM,4 // Master mode: Connection can be controled with GPIO6
-SF,1 // Factroy reset
-R,1 // reboot
-SR,Z // removes all remote addresses for reconnecting.
- // can be used to connect another host
-SR,I // registers last inquiry address
-
-
-Operation Modes
----------------
-SM,3 Auto Connect Master mode
-SM,4 Auto Connect DTR Mode uses GPIO6 to make and break connection(Mode =DTR)
- confirm: auto connect works and control connection with GPIO6
-SM,5 Auto Connect ANY Mode (Mode =ANY)
- each time GPIO is set, make inquiry and connect to the first found device
-SM,6 automatically reconnect(Mode =Pair)
- confirm: auto connect works well but difficult to enter command mode.
-
-
-HID flag register
------------------
-SH,0200
-GH
-
-10 0000 0000(0200) default
-00 0011 1000(0038) Combo
-|| | | |\_\____ number of paired devices to which the module can reconnect
-|| | | \_______ send out reports over UART (0xFF <len> <data>)
-|| \__\_________ descriptor type
-|\______________ toggle virtual keyboard on iOS when first connected
-\_______________ Force HID mode if GPIO11 is high on power-up
-
- Descriptor type:
- 0000: keybaord
- 0001: Game Pad
- 0010: Mouse
- 0011: Combo
- 0100: Joystick
- 1xxx: reserved
-
-
-Out report - Indicator
-----------------------
-0xFE 0x02 0x01 <LED_state>
-
-
-Apple iOS
----------
-Keyboard can be used with iPhone, but mouse cannot.
-
-
-Android
--------
-3.7.1.5 Note: To connect with Android phone the modules must wake up 11ms every 2.5seconds.
-
-
-Power Management
-----------------
-Inquiry and Page window Idle or Active (3.1.1)
- Downside: delay in discovery or connection time
- SI, // set inquiry scan window(discovery) on/off duty?
- SJ, // set page scan window(connection)
- This reduces averaege power >20mA to 5mA(3mA in Sniff mode)
-
-Sniff mode Transmit
- Sniff mode is disabled by default and radio is active continuously when connected.(25-30mA)
- In Sniff mode the radio wakes up intermittently and sleeps in very low power mode.(2mA)
- SW,<val> // set interval timer(*0.625ms) 0000-7FFF
-
-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.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)
- *toggle CTS low to high and wait 5ms
- *wake automatically every slot time(<val>*0.625ms)
- Once the radio is awake it stay active for exactly 1 second of inactivity and then sleeps again.
- Downside: latency and data loss
-
-Disable Output driver Idle or Active (3.1.3)
- S%,1000 // set all GPIO pins(0-11) to inputs.
-
-Lower Transmit Power Idle or Active (3.1.4)
- SY,<hex> // transmit power setting(takes effect after a power cycle and reboot)
- Downside: reducing effective range
-
-
-Optimizig for Latency
----------------------
-By default the firmware is optimized for throughput.
-SQ,16 // set latency bit
-SQ,0 // unset latency bit
-
-
-Configuration timer settings
-----------------------------
-Remote configuration is used for the module to be configured with various commands over Bluetooth(SPP profile only?).
-
-The module has remote configuration timer to allow remote configuration over Bluetooth after power up in Slave mode. In Master modes the remote configuration timer is set to 0(no remote configuration). (In Trigger Master mode the timer is used as an idle timer to break the connection after time expires with no charactors receive.)
- ST,0 // no remote, no local when connected
- ST,<1-252> // local and remote with timeout in seconds from power up
- ST,253 // local only without timeout
- ST,254 // remote only without timeout
- ST,255 // local and remote without timeout
-
-
-Commands
---------
-S7, 7bit mode
-SA, Authenticaiton
-SB, Send break
-SC, Service class
-SD, Device class
-SM,<val> Operation mode
-SP,<string> Pin code(alpahnumeric)
-SQ,<mask> Special configuration(GPIO, discovery mode, low latency, reboot, UART)
-SR,<hex> Store remote address
-SR,Z Erase all address
-SS,<string> Set service name(1-20)**
-ST,<val> Remote configuration timer(Master:0, Slave:0-255, Triger:as idle timer)
-SU,<val> UART baud rate
-SW,<val> low-power sniff mode** deep sleep and wake up every 625us * <val>
-SX,<0|1> bonding enable only acceps device that matches the stored address
-SY,<hex> power setting**
-SZ,<val> non-standard raw baud rate <val>=baud*0.004096
-S~,<val> Profile 0:SPP, 5:APL, 6:HID
-S-,<string> Device name -1