cdisselkoen / kaleidoscope-hardware-virtual Goto Github PK

Very nice piece of software!
For my testing application, timing is somewhat crucial. Is there a possibility to skip a number of scan cycles or even better, some milliseconds? How is timing handled in the simulation, anyway?

A class in the firmware core apparently has gained a new method

https://github.com/keyboardio/Arduino-HID/blob/c5b309cb600dcc195d936f263bd2187aa224b2df/src/HID.h#L95

Due to it missing in class Keyboard_

Before I can build the HV plugin with the stock firmware sketch from Arduino-Boards, I always have to uncomment things related to the Kaleidoscope-Numlock and Kaleidoscope-Model01-TestMode in the stock sketch due to build errors.

This might be valuable information for other users that want to try out the HV plugin. Could this possibly be added to the README.md. Unless, of course, there is any other possible workaround that would enable to build without the required modifications described.

This is not exactly an issue but rather a question. BTW, is this the right place to ask? I could also have asked at community.keyboard.io but I think that this question is too specific.

I am currently developing another plugin that builds a x86 version of the firmware, strongly related to the HV plugins approach. What differs is that my plugin builds a shared library that can be loaded as a python module. That's why I need slighly different compile flags.

To benefit as much as possible from the implementation of the HV plugin, I reuse most of its build system tweaks and code. To achieve this, I let my plugin have a directory support/x86 that is almost identical similar to that of the HV plugin, except for not using own copies of most files but let symbolic links point to the equivalent files of the HV plugin.

This the content of my plugin's support/x86 directory:

boards.txt
cores -> ../../../Kaleidoscope-Hardware-Virtual/support/x86/cores/
libraries -> <my_hardware_path>keyboardio/avr/libraries
variants -> ../../../Kaleidoscope-Hardware-Virtual/support/x86/variants/

The libraries link is generated during setup in a similar way as it is necessary for the orginal HV plugin. I only need a custom boards.txt file, as my compiler flags are different, e.g. -fpic is required.

This is the content of boards.txt:

virtual.name="Kaleidoscope Python Interface"
virtual.build.usb_product="Kaleidoscope Python Interface"
virtual.build.usb_manufacturer="Kaleidoscope"
virtual.build.board=VIRTUAL
virtual.build.core=virtual
virtual.build.variant=virtual
virtual.build.extra_flags=-DKALEIDOSCOPE_HARDWARE_H="Kaleidoscope-Hardware-Virtual.h" "-I/usr/include" "-I/usr/include/python2.7" -fPIC -fpermissive

I build with

cd <my_hardware_path>/keyboardio/avr/libraries/Model01-Firmware
BOARD=virtual BOARD_HARDWARE_PATH=<my_hardware_path> make

Unfortunately, I have a problem that the overall Arduino build system does try to compile files that are not meant to be part of the virtual build, such as KeyboardioHID/src/BootKeyboard/BootKeyboard.cpp.

To make sure that the overall methodology is correct, I build the HV plugin together with a slightly modified stock firmware (see #3). This build works fine.

Is there anything wrong with the symbolic link approach taken by my plugin or any other possible reason for my build to fail?