Giter VIP home page Giter VIP logo

sipeed_keyboard's Introduction

sipeed_keyboard

FirmwareCI

sipeed opensource mechanical keyboard(SMK) made with BL706

矽π 开源双模机械键盘

特性

  • 主控使用 BL706, 使用 RISC-V 核, 支持蓝牙和 USB代码开源
  • 键轴支持热插拔

使用指导

如果你想快速用上这款开源键盘:

  • Sipeed 购买 SMK68 键盘底板(可能需要询问商家),不包含键帽和键轴
  • 自行购买键轴和键帽(68键),组装成完整键盘
  • 出厂自带了固件,可以插上 USB 测试按键是否均能响应,至此键盘已经可以正常使用
  • 更新固件:在 release 页面下载最新固件,按照固件升级方法升级固件
  • 使用软件自定义按键(待做)

如果你想更深入地定制你的键盘, 本项目下包含了

  • 键盘硬件(PCB 板)原理图
  • 键盘固件源码
  • 软件源码(运行在电脑上)

只需要克隆本项目到本地,根据你的喜好进行修改即可,也欢迎参与贡献,大家一起改进体验!

目录结构

├── LICENSE    // 开源证书
├── README.md
├── firmware   // 存放键盘固件
├── hardware   // 硬件设计
├── software   // 上位机软件
├── teamworks  // 贡献记录
└── tools      // 工具

构建键盘固件

git clone https://github.com/sipeed/sipeed_keyboard.git
cd sipeed_keyboard
git submodule init
git submodule update
  • 编译固件
cd firmware/bl_mcu_sdk
make build BOARD=sipeed_keyboard APP=sipeed_keyboard_68 APP_DIR=../keyboard
  • 烧录固件到键盘

根据 开发环境搭建指南 里面所述进行烧录

以 Linux 为例:

  • 按住键盘的 BOOT 按键
  • 然后按 RESET 按键
  • 片刻后松开两个按键(松开不论顺序)
  • 使用ls /dev/tty* 命令查看到出现的串口设备,比如叫/dev/ttyACM0
  • 然后再firmware/bl_mcu_sdk目录下执行烧录命令
make download INTERFACE=uart COMx=/dev/ttyACM0

烧录结束后需要手动按一下 RESET 按键来重启键盘

开源证书

代码采用 Apache 2.0 开源协议, 参与贡献后可以在修改的文件头注释标明修改和日期

贡献者

参与贡献

  • 项目进度可以在 sipeed_keyboard/projects 看到, 为领取的任务可以领取一起做~
  • 可以发起issues,做好了提交 Pulll Request
  • 可以加 QQ 群参与讨论( 933963409 )

致谢

本项目在开发过程中参考/使用了下列项目中的代码

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.