alexey.zholtikov/mozc-devices
1
0
Fork 0
mirror of https://github.com/google/mozc-devices.git synced 2025-11-08 16:53:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add mozc dial version.

Browse Source 
Co-authored-by: Takashi Toyoshima <toyoshim@google.com>
Co-authored-by: Shun Ikejima <ikejima@google.com>
This commit is contained in:
Shun Ikejima
2025-10-01 10:01:00 +09:00
parent 9b4017fb9b
commit 6783bfea76
88 changed files with 233948 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
mozc-dial/firmware/main/CMakeLists.txt Normal file
View File

@@ -0,0 +1,78 @@
# Generated Cmake Pico project file
cmake_minimum_required(VERSION 3.13)
set(CMAKE_C_STANDARD 11)
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
# Initialise pico_sdk from installed location
# (note this can come from environment, CMake cache etc)
# == DO NOT EDIT THE FOLLOWING LINES for the Raspberry Pi Pico VS Code Extension to work ==
if(WIN32)
set(USERHOME $ENV{USERPROFILE})
else()
set(USERHOME $ENV{HOME})
endif()
set(sdkVersion 2.2.0)
set(toolchainVersion 14_2_Rel1)
set(picotoolVersion 2.2.0)
set(picoVscode ${USERHOME}/.pico-sdk/cmake/pico-vscode.cmake)
if (EXISTS ${picoVscode})
include(${picoVscode})
endif()
# ====================================================================================
set(PICO_BOARD none CACHE STRING "Board type")
# Pull in Raspberry Pi Pico SDK (must be before project)
include(pico_sdk_import.cmake)
project(main C CXX ASM)
# Initialise the Raspberry Pi Pico SDK
pico_sdk_init()
# Add executable. Default name is the project name, version 0.1
add_executable(main
../common/dial_controller.cc
../common/dial_controller.h
../common/photo_sensor.cc
../common/photo_sensor.h
../common/usage_tables.cc
../common/usage_tables.h
../common/usb_device.cc
../common/usb_device.h
../common/usb_hid_device.cc
../common/usb_hid_device.h
../common/usb_hid_keyboard.cc
../common/usb_hid_keyboard.h
i2c_controller.cc
i2c_controller.h
main.cc
)
pico_set_program_name(main "main")
pico_set_program_version(main "0.1")
# Modify the below lines to enable/disable output over UART/USB/SEMIHOSTING
pico_enable_stdio_uart(main 1)
pico_enable_stdio_usb(main 0)
pico_enable_stdio_semihosting(main 0)
# Add the standard library to the build
target_link_libraries(main
pico_stdlib)
# Add the standard include files to the build
target_include_directories(main PRIVATE
${CMAKE_CURRENT_LIST_DIR}
)
# Add any user requested libraries
target_link_libraries(main
hardware_i2c
)
pico_add_extra_outputs(main)

47
mozc-dial/firmware/main/i2c_controller.cc Normal file
View File

@@ -0,0 +1,47 @@
// Copyright 2025 Google Inc.
// Use of this source code is governed by an Apache License that can be found
// in the LICENSE file.
#include "i2c_controller.h"
#include <algorithm>
#include <vector>
#include "hardware/gpio.h"
static constexpr int kI2CSpeedInHz = 400 * 1000;
I2CController::I2CController(i2c_inst_t* i2c, int8_t sda, int8_t scl)
: i2c_(i2c) {
hard_assert(i2c == i2c0 || i2c == i2c1);
gpio_init(sda);
gpio_init(scl);
gpio_set_function(sda, GPIO_FUNC_I2C);
gpio_set_function(scl, GPIO_FUNC_I2C);
gpio_pull_up(sda);
gpio_pull_up(scl);
i2c_init(i2c_, kI2CSpeedInHz);
}
bool I2CController::Read(uint8_t device_addr,
uint8_t mem_addr,
std::span<uint8_t> data) {
uint8_t addr[1] = {mem_addr};
int result = i2c_write_blocking(i2c_, device_addr, addr, 1, true);
if (result != 1) {
return false;
}
result = i2c_read_blocking(i2c_, device_addr, data.data(), data.size(), false);
return result == data.size();
}
bool I2CController::Write(uint8_t device_addr,
uint8_t mem_addr,
std::span<uint8_t> data) {
std::vector<uint8_t> buf;
buf.reserve(data.size() + 1);
buf.push_back(mem_addr);
buf.insert(buf.end(), data.begin(), data.end());
int rc = i2c_write_blocking(i2c_, device_addr, buf.data(), buf.size(), false);
return rc == buf.size();
}

27
mozc-dial/firmware/main/i2c_controller.h Normal file
View File

@@ -0,0 +1,27 @@
// Copyright 2025 Google Inc.
// Use of this source code is governed by an Apache License that can be found
// in the LICENSE file.
#ifndef I2C_CONTROLLER_H_
#define I2C_CONTROLLER_H_
#include <cstdint>
#include <span>
#include "hardware/i2c.h"
class I2CController final {
public:
I2CController(i2c_inst_t* i2c, int8_t sda, int8_t scl);
I2CController(const I2CController&) = delete;
I2CController& operator=(const I2CController&) = delete;
~I2CController() = default;
bool Write(uint8_t device_addr, uint8_t mem_addr, std::span<uint8_t> data);
bool Read(uint8_t device_addr, uint8_t mem_addr, std::span<uint8_t> data);
private:
i2c_inst_t* i2c_ = nullptr;
};
#endif // I2C_CONTROLLER_H_

170
mozc-dial/firmware/main/main.cc Normal file
View File

@@ -0,0 +1,170 @@
// Copyright 2025 Google Inc.
// Use of this source code is governed by an Apache License that can be found
// in the LICENSE file.
#include <array>
#include <cstdint>
#include <cstdio>
#include <vector>
#include "hardware/uart.h"
#if LIB_PICO_STDIO_UART
#include "pico/stdio_uart.h"
#endif
#include "pico/stdlib.h"
#include "../common/dial_controller.h"
#include "../common/motor_controller.h"
#include "../common/photo_sensor.h"
#include "../common/usage_tables.h"
#include "../common/usb_hid_keyboard.h"
#include "i2c_controller.h"
int main() {
#if LIB_PICO_STDIO_UART
stdio_uart_init_full(uart0, /*baud_rate=*/115200, /*tx_pin=*/0,
/*rx_pin=*/-1);
#else
stdio_init_all();
#endif
I2CController i2c(i2c0, /*sda=*/28, /*scl=*/29);
// Sensor A, B, C, D, E, F, G, I (note: H is missing here as it's accessed via
// I2C)
std::array<PhotoSensor, 8> sensors = {
PhotoSensor(1, 2, 3, 4, 5, 6), // A
PhotoSensor(7, 8), // B
PhotoSensor(9, 10, 11), // C
PhotoSensor(12, 13), // D (3 sensors are implemented, but...)
PhotoSensor(15, 16, 17), // E
PhotoSensor(18, 19, 20), // F
PhotoSensor(21, 22), // G (3 sensors are implemented, but...)
PhotoSensor(24, 25, 26, 27), // I
};
std::array<DialController, 9> dials = {
DialController(), // A
DialController(), // B
DialController(), // C
DialController(), // D
DialController(), // E
DialController(), // F
DialController(), // G
DialController(), // I
DialController(), // H
};
std::array<const std::vector<uint8_t>*, 9> usages = {
&usage_tables::a, // A
&usage_tables::b, // B
&usage_tables::c, // C
&usage_tables::d, // D
&usage_tables::e, // E
&usage_tables::f, // F
&usage_tables::g, // G
&usage_tables::i, // I
&usage_tables::h, // H
};
std::array<const std::vector<uint8_t>*, 9> fn_usages = {
&usage_tables::fn_a, // A
&usage_tables::fn_b, // B
&usage_tables::fn_c, // C
&usage_tables::fn_d, // D
&usage_tables::fn_e, // E
&usage_tables::fn_f, // F
&usage_tables::fn_g, // G
&usage_tables::fn_i, // I
&usage_tables::fn_h, // H
};
std::array<const std::vector<uint8_t>*, 9> modifiers = {
&usage_tables::modifier_a, // A
&usage_tables::modifier_b, // B
&usage_tables::modifier_c, // C
&usage_tables::modifier_d, // D
&usage_tables::modifier_e, // E
&usage_tables::modifier_f, // F
&usage_tables::modifier_g, // G
&usage_tables::modifier_i, // I
&usage_tables::modifier_h, // H
};
UsbHidKeyboard usb_hid_keyboard(
/*vendor_id=*/0x6666, /*product_id=*/0x2025,
/*version=*/0x0109, /*vendor_name=*/"Gboard DIY prototype",
/*product_name=*/"Gboard Dial version", /*version_name=*/"9 Dial");
usb_hid_keyboard.SetAutoKeyRelease(true);
// Wait for a while, just in case, so that the sub-controller can be ready on
// I2C.
sleep_ms(100);
std::vector<uint8_t> i2c_buffer(2);
bool fn = false;
while (true) {
uint16_t motor_start_bitmap = 0;
for (size_t i = 0; i < sensors.size(); ++i) {
dials[i].Update(sensors[i].Read());
if (!dials[i].IsBasePosition()) {
motor_start_bitmap |= (1 << i);
}
}
// Read the remote sensor H value via I2C.
bool rc = i2c.Read(68, 0, std::span<uint8_t>({i2c_buffer.data(), 1}));
if (rc) {
dials[8].Update(i2c_buffer[0]);
if (!dials[8].IsBasePosition()) {
motor_start_bitmap |= (1 << 8);
}
}
// Drive all motors via I2C.
i2c_buffer[0] = motor_start_bitmap & 0xff;
i2c_buffer[1] = motor_start_bitmap >> 8;
rc = i2c.Write(68, 0, i2c_buffer);
// Check all dials to see if we have pending inputs to send over USB HID.
for (size_t i = 0; i < dials.size(); ++i) {
// `decided_position` is std::nullopt while the dial is not moved at the
// base position, or moving. But once it returns to the base position from
// non-base positions, it will have a 1 or a larger value that indicates
// the position where the dial starts returning.
std::optional<uint8_t> decided_position = dials[i].PopDecidedPosition();
if (!decided_position) {
continue;
}
// One-time flip to use an alternative set of usages, by the Fn key.
std::array<const std::vector<uint8_t>*, 9>& current_usages =
fn ? fn_usages : usages;
// Adjust the index as it is 1-based.
size_t index = *decided_position - 1;
if (index < current_usages[i]->size()) {
uint8_t usage = (*current_usages[i])[index];
if (usage) {
usb_hid_keyboard.PressByUsageId(usage);
fn = false;
}
}
if (index < modifiers[i]->size()) {
uint8_t modifier = (*modifiers[i])[index];
if (modifier == usage_tables::kModifierLeftGUI) {
// This device interprets the left GUI key as a one-time keymap
// alternate key instead of the normal GUI modifier key use.
fn = true;
} else {
usb_hid_keyboard.SetModifiers(
(usb_hid_keyboard.GetModifiers() | modifier));
}
}
}
}
}

121
mozc-dial/firmware/main/pico_sdk_import.cmake Normal file
View File

@@ -0,0 +1,121 @@
# This is a copy of <PICO_SDK_PATH>/external/pico_sdk_import.cmake
# This can be dropped into an external project to help locate this SDK
# It should be include()ed prior to project()
# Copyright 2020 (c) 2020 Raspberry Pi (Trading) Ltd.
#
# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
# following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
# disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
# disclaimer in the documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
if (DEFINED ENV{PICO_SDK_PATH} AND (NOT PICO_SDK_PATH))
set(PICO_SDK_PATH $ENV{PICO_SDK_PATH})
message("Using PICO_SDK_PATH from environment ('${PICO_SDK_PATH}')")
endif ()
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT} AND (NOT PICO_SDK_FETCH_FROM_GIT))
set(PICO_SDK_FETCH_FROM_GIT $ENV{PICO_SDK_FETCH_FROM_GIT})
message("Using PICO_SDK_FETCH_FROM_GIT from environment ('${PICO_SDK_FETCH_FROM_GIT}')")
endif ()
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT_PATH} AND (NOT PICO_SDK_FETCH_FROM_GIT_PATH))
set(PICO_SDK_FETCH_FROM_GIT_PATH $ENV{PICO_SDK_FETCH_FROM_GIT_PATH})
message("Using PICO_SDK_FETCH_FROM_GIT_PATH from environment ('${PICO_SDK_FETCH_FROM_GIT_PATH}')")
endif ()
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT_TAG} AND (NOT PICO_SDK_FETCH_FROM_GIT_TAG))
set(PICO_SDK_FETCH_FROM_GIT_TAG $ENV{PICO_SDK_FETCH_FROM_GIT_TAG})
message("Using PICO_SDK_FETCH_FROM_GIT_TAG from environment ('${PICO_SDK_FETCH_FROM_GIT_TAG}')")
endif ()
if (PICO_SDK_FETCH_FROM_GIT AND NOT PICO_SDK_FETCH_FROM_GIT_TAG)
set(PICO_SDK_FETCH_FROM_GIT_TAG "master")
message("Using master as default value for PICO_SDK_FETCH_FROM_GIT_TAG")
endif()
set(PICO_SDK_PATH "${PICO_SDK_PATH}" CACHE PATH "Path to the Raspberry Pi Pico SDK")
set(PICO_SDK_FETCH_FROM_GIT "${PICO_SDK_FETCH_FROM_GIT}" CACHE BOOL "Set to ON to fetch copy of SDK from git if not otherwise locatable")
set(PICO_SDK_FETCH_FROM_GIT_PATH "${PICO_SDK_FETCH_FROM_GIT_PATH}" CACHE FILEPATH "location to download SDK")
set(PICO_SDK_FETCH_FROM_GIT_TAG "${PICO_SDK_FETCH_FROM_GIT_TAG}" CACHE FILEPATH "release tag for SDK")
if (NOT PICO_SDK_PATH)
if (PICO_SDK_FETCH_FROM_GIT)
include(FetchContent)
set(FETCHCONTENT_BASE_DIR_SAVE ${FETCHCONTENT_BASE_DIR})
if (PICO_SDK_FETCH_FROM_GIT_PATH)
get_filename_component(FETCHCONTENT_BASE_DIR "${PICO_SDK_FETCH_FROM_GIT_PATH}" REALPATH BASE_DIR "${CMAKE_SOURCE_DIR}")
endif ()
FetchContent_Declare(
pico_sdk
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk
GIT_TAG ${PICO_SDK_FETCH_FROM_GIT_TAG}
)
if (NOT pico_sdk)
message("Downloading Raspberry Pi Pico SDK")
# GIT_SUBMODULES_RECURSE was added in 3.17
if (${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.17.0")
FetchContent_Populate(
pico_sdk
QUIET
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk
GIT_TAG ${PICO_SDK_FETCH_FROM_GIT_TAG}
GIT_SUBMODULES_RECURSE FALSE
SOURCE_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-src
BINARY_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-build
SUBBUILD_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-subbuild
)
else ()
FetchContent_Populate(
pico_sdk
QUIET
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk
GIT_TAG ${PICO_SDK_FETCH_FROM_GIT_TAG}
SOURCE_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-src
BINARY_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-build
SUBBUILD_DIR ${FETCHCONTENT_BASE_DIR}/pico_sdk-subbuild
)
endif ()
set(PICO_SDK_PATH ${pico_sdk_SOURCE_DIR})
endif ()
set(FETCHCONTENT_BASE_DIR ${FETCHCONTENT_BASE_DIR_SAVE})
else ()
message(FATAL_ERROR
"SDK location was not specified. Please set PICO_SDK_PATH or set PICO_SDK_FETCH_FROM_GIT to on to fetch from git."
)
endif ()
endif ()
get_filename_component(PICO_SDK_PATH "${PICO_SDK_PATH}" REALPATH BASE_DIR "${CMAKE_BINARY_DIR}")
if (NOT EXISTS ${PICO_SDK_PATH})
message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' not found")
endif ()
set(PICO_SDK_INIT_CMAKE_FILE ${PICO_SDK_PATH}/pico_sdk_init.cmake)
if (NOT EXISTS ${PICO_SDK_INIT_CMAKE_FILE})
message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' does not appear to contain the Raspberry Pi Pico SDK")
endif ()
set(PICO_SDK_PATH ${PICO_SDK_PATH} CACHE PATH "Path to the Raspberry Pi Pico SDK" FORCE)
include(${PICO_SDK_INIT_CMAKE_FILE})