ZSA Keyboards - Revision history

Atemo C: Formatting tweaks, information fixes, typo fixes, deletion of duplicate information, and updated information related to the Keymapp program with the release of NixOS 24.05.

2024-06-11T13:59:58Z

Formatting tweaks, information fixes, typo fixes, deletion of duplicate information, and updated information related to the Keymapp program with the release of NixOS 24.05.

← Older revision		Revision as of 13:59, 11 June 2024
Line 1:		Line 1:
	~~ZSA~~.io offers a variety of ergonomic keyboards such as the Ergodox EZ and Moonlander Mark I~~. Its possible to configure the keyboard layout via https://configure.zsa.io/ and then flash it to the keyboard. Flashing is done via Browser (Chrome, Chromium) or via a desktop application~~.		[https://www.zsa.io/ ZSA] offers a variety of ergonomic keyboards, such as the Ergodox EZ and the Moonlander Mark I.

	~~To just~~ use a ZSA ~~keyboard its~~ not ~~necessary~~ to ~~change~~ the NixOS configuration.		The use of ZSA's keyboards does not require any change to the NixOS configuration, but flashing firmware onto them does.
	~~= Flashing =~~
	~~== Flashing via Chrome/Chromium Browser ==~~
	~~In Oryx ( https://configure.zsa.io/ ) you can just click „Safe to my keyboard“ to flash the keyboard~~.

	~~There are some udev rules necessary for the connection~~. You ~~have~~ to ~~activate them~~ in NixOS configuration ~~first:~~		= Configuring a keyboard =
			ZSA's keyboards can be configured using their online [https://configure.zsa.io Oryx configurator tool]. You will then need to flash the firmware onto the keyboard, which can be done in three ways, all necessitating a common change in the NixOS configuration, as seen in the following section.

			= Flashing firmware =
			== Pre-requirement ==
			Some udev rules are necessary for the connection before flashing any firmware onto the keyboard. You have to activate them in your NixOS configuration first:
	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
	hardware.keyboard.zsa.enable = true;		hardware.keyboard.zsa.enable = true;
	</nowiki>}}		</nowiki>}}
			Once the new configuration is applied, you may flash ZSA's keyboards with one of the three following methods.

	== Flashing via ~~wally~~-~~cli~~ (~~command line tool~~, ~~deprecated~~) ==		== Flashing via a Chromium-based web browser (Chrome, Chromium...)==
	ZSA ~~keyboards can be flashed using the <code>wally-cli<~~/~~code> command-line~~ tool~~. There are some udev rules necessary for~~ the ~~connection~~. ~~You have to activate them in NixOS configuration first:~~		In ZSA's [https://configure.zsa.io Oryx configurator tool], you can click “Save to my keyboard” to flash the keyboard.

	~~{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>~~		== Flashing via wally-cli (command line tool) ==
	~~hardware.keyboard.zsa.enable~~ = ~~true;~~		ZSA's <code>[https://github.com/zsa/wally-cli wally-cli]</code> command-line tool can be used to flash the keyboard. You will need to install it:
	<~~/nowiki~~>}}

	~~In addition, you need to install wally-cli~~[https://github.com/zsa/wally-cli]:

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 25:		Line 24:
	</nowiki>}}		</nowiki>}}

	== Flashing via ~~keymapp~~ (~~command line~~ tool) ==		Then, you may use the following command to flash the keyboard, replacing the path with the location of the downloaded firmware:
	ZSA ~~keyboards can be flashed using the~~ <code>keymapp</code> ~~command-line~~ tool. ~~There are some udev rules necessary for the connection~~. You ~~have~~ to ~~activate them in NixOS configuration first~~:		{{bc\|wally-cli /path/to/firmware.bin}}

			== Flashing via Keymapp (graphical tool) ==
			ZSA's <code>[https://blog.zsa.io/keymapp/ keymapp]</code> graphical tool can be used to flash the keyboard. It is user-friendly, and has other features, such as live layout viewing, key presses heatmap, and links to various tools offered by ZSA's online Oryx configurator. You will need to install it:

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
	~~hardware~~.~~keyboard.zsa.enable~~ = ~~true~~;		environment.systemPackages = with pkgs; [ keymapp ];
	</nowiki>}}		</nowiki>}}
	~~Unfortunately keymapp is not yet available as package for NixOS.~~

	[[Category: Hardware]]		[[Category: Hardware]]

Klinger at 16:34, 15 April 2024

2024-04-15T16:34:05Z

← Older revision		Revision as of 16:34, 15 April 2024
Line 13:		Line 13:

	== Flashing via wally-cli (command line tool, deprecated) ==		== Flashing via wally-cli (command line tool, deprecated) ==
	ZSA keyboards can be flashed using the <code>wally-cli</code> command-line tool. ~~The ZSA~~ udev rules ~~can be set up automatically with~~ the ~~<code>hardware.keyboard.zsa</code> config option~~.		ZSA keyboards can be flashed using the <code>wally-cli</code> command-line tool. There are some udev rules necessary for the connection. You have to activate them in NixOS configuration first:

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 26:		Line 26:

	== Flashing via keymapp (command line tool) ==		== Flashing via keymapp (command line tool) ==
	ZSA keyboards can be flashed using the <code>keymapp</code> command-line tool. ~~The ZSA~~ udev rules ~~can be set up automatically with~~ the ~~<code>hardware.keyboard.zsa</code> config option~~.		ZSA keyboards can be flashed using the <code>keymapp</code> command-line tool. There are some udev rules necessary for the connection. You have to activate them in NixOS configuration first:

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>

Klinger: description of ZSA keyboards, added 2 different ways to flash keyboards

2024-04-15T16:30:20Z

description of ZSA keyboards, added 2 different ways to flash keyboards

← Older revision		Revision as of 16:30, 15 April 2024
Line 1:		Line 1:
	== Flashing ==		ZSA.io offers a variety of ergonomic keyboards such as the Ergodox EZ and Moonlander Mark I. Its possible to configure the keyboard layout via https://configure.zsa.io/ and then flash it to the keyboard. Flashing is done via Browser (Chrome, Chromium) or via a desktop application.

	ZSA keyboards ~~such as the Ergodox EZ and Moonlander Mark I~~ can be flashed using the <code>wally-cli</code> command-line tool. The ZSA udev rules can be set up automatically with the <code>hardware.keyboard.zsa</code> config option~~. In previous versions, your user had to be a member of the <code>plugdev</code> group~~.		To just use a ZSA keyboard its not necessary to change the NixOS configuration.
			= Flashing =
			== Flashing via Chrome/Chromium Browser ==
			In Oryx ( https://configure.zsa.io/ ) you can just click „Safe to my keyboard“ to flash the keyboard.

			There are some udev rules necessary for the connection. You have to activate them in NixOS configuration first:

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			hardware.keyboard.zsa.enable = true;
			</nowiki>}}

			== Flashing via wally-cli (command line tool, deprecated) ==
			ZSA keyboards can be flashed using the <code>wally-cli</code> command-line tool. The ZSA udev rules can be set up automatically with the <code>hardware.keyboard.zsa</code> config option.

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
Line 7:		Line 19:
	</nowiki>}}		</nowiki>}}

	In addition, you ~~might also want~~ to install wally-cli[https://github.com/zsa/wally-cli]:		In addition, you need to install wally-cli[https://github.com/zsa/wally-cli]:

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
	environment.systemPackages = with pkgs; [ wally-cli ];		environment.systemPackages = with pkgs; [ wally-cli ];
	</nowiki>}}		</nowiki>}}

			== Flashing via keymapp (command line tool) ==
			ZSA keyboards can be flashed using the <code>keymapp</code> command-line tool. The ZSA udev rules can be set up automatically with the <code>hardware.keyboard.zsa</code> config option.

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			hardware.keyboard.zsa.enable = true;
			</nowiki>}}
			Unfortunately keymapp is not yet available as package for NixOS.

	[[Category: Hardware]]		[[Category: Hardware]]

imported>Fufexan: Add page to Hardware category

2022-08-09T17:32:56Z

Add page to Hardware category

← Older revision		Revision as of 17:32, 9 August 2022
Line 12:		Line 12:
	environment.systemPackages = with pkgs; [ wally-cli ];		environment.systemPackages = with pkgs; [ wally-cli ];
	</nowiki>}}		</nowiki>}}

			[[Category: Hardware]]

imported>Michielboekhoff: Updated docs about plugdev group + wally-cli

2022-06-03T11:50:55Z

Updated docs about plugdev group + wally-cli

← Older revision		Revision as of 11:50, 3 June 2022
Line 1:		Line 1:
	== Flashing ==		== Flashing ==

	ZSA keyboards such as the Ergodox EZ and Moonlander Mark I can be flashed using the <code>wally-cli</code> command-line tool. The ZSA udev rules can be set up automatically with the <code>hardware.keyboard.zsa</code> config option. ~~Your~~ user ~~must also~~ be a member of the <code>plugdev</code> group.		ZSA keyboards such as the Ergodox EZ and Moonlander Mark I can be flashed using the <code>wally-cli</code> command-line tool. The ZSA udev rules can be set up automatically with the <code>hardware.keyboard.zsa</code> config option. In previous versions, your user had to be a member of the <code>plugdev</code> group.

	{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>		{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
	~~users.users.yourUser = {~~
	~~extraGroups = [ "plugdev" ];~~
	};
	hardware.keyboard.zsa.enable = true;		hardware.keyboard.zsa.enable = true;
			</nowiki>}}

			In addition, you might also want to install wally-cli[https://github.com/zsa/wally-cli]:

			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			environment.systemPackages = with pkgs; [ wally-cli ];
	</nowiki>}}		</nowiki>}}

imported>R-burns: Create instructions for flashing ZSA keyboards

2021-02-02T02:17:23Z

Create instructions for flashing ZSA keyboards

New page

== Flashing ==

ZSA keyboards such as the Ergodox EZ and Moonlander Mark I can be flashed using the <code>wally-cli</code> command-line tool. The ZSA udev rules can be set up automatically with the <code>hardware.keyboard.zsa</code> config option. Your user must also be a member of the <code>plugdev</code> group.

{{file|/etc/nixos/configuration.nix|nix|<nowiki>
users.users.yourUser = {
extraGroups = [ "plugdev" ];
};
hardware.keyboard.zsa.enable = true;
</nowiki>}}