Begin rog-aura crate

Cargo.lock

@@ -49,6 +49,7 @@ dependencies = [
  "glam",
  "gumdrop",
  "rog_anime",
+ "rog_aura",
  "rog_dbus",
  "rog_types",
  "serde_json",
@@ -212,6 +213,7 @@ dependencies = [
  "log",
  "logind-zbus",
  "rog_anime",
+ "rog_aura",
  "rog_dbus",
  "rog_fan_curve",
  "rog_types",
@@ -910,11 +912,23 @@ dependencies = [
  "zvariant_derive",
 ]
 
+[[package]]
+name = "rog_aura"
+version = "1.0.0"
+dependencies = [
+ "serde",
+ "serde_derive",
+ "zbus",
+ "zvariant",
+ "zvariant_derive",
+]
+
 [[package]]
 name = "rog_dbus"
 version = "3.2.0"
 dependencies = [
  "rog_anime",
+ "rog_aura",
  "rog_fan_curve",
  "rog_types",
  "serde_json",
@@ -937,6 +951,7 @@ name = "rog_types"
 version = "3.2.0"
 dependencies = [
  "gumdrop",
+ "rog_aura",
  "rog_fan_curve",
  "serde",
  "serde_derive",

asusctl/Cargo.toml

@@ -10,6 +10,7 @@ edition = "2018"
 # serialisation
 serde_json = "^1.0"
 rog_anime = { path = "../rog-anime" }
+rog_aura = { path = "../rog-aura" }
 rog_dbus = { path = "../rog-dbus" }
 rog_types = { path = "../rog-types" }
 daemon = { path = "../daemon" }

asusctl/examples/aura-rgb-ball.rs

@@ -1,5 +1,5 @@
 use rog_dbus::AuraDbusClient;
-use rog_types::aura_perkey::{GX502Layout, Key, KeyColourArray, KeyLayout};
+use rog_aura::{GX502Layout, Key, KeyColourArray, KeyLayout};
 use std::collections::LinkedList;
 
 #[derive(Debug, Clone)]

asusctl/examples/aura-rgb-comet.rs

@@ -1,5 +1,5 @@
 use rog_dbus::AuraDbusClient;
-use rog_types::aura_perkey::{GX502Layout, KeyColourArray, KeyLayout};
+use rog_aura::{GX502Layout, KeyColourArray, KeyLayout};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let (dbus, _) = AuraDbusClient::new()?;

asusctl/examples/aura-rgb-iterate-keys.rs

@@ -1,5 +1,5 @@
 use rog_dbus::AuraDbusClient;
-use rog_types::aura_perkey::{GX502Layout, Key, KeyColourArray, KeyLayout};
+use rog_aura::{GX502Layout, Key, KeyColourArray, KeyLayout};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let (dbus, _) = AuraDbusClient::new()?;

asusctl/examples/aura-rgb-per-key-effect-2.rs

@@ -1,5 +1,5 @@
 use rog_dbus::AuraDbusClient;
-use rog_types::aura_perkey::{Key, KeyColourArray};
+use rog_aura::{Key, KeyColourArray};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let (dbus, _) = AuraDbusClient::new()?;

asusctl/examples/aura-rgb-pulser.rs

@@ -1,5 +1,5 @@
 use rog_dbus::AuraDbusClient;
-use rog_types::aura_perkey::{GX502Layout, KeyColourArray, KeyLayout};
+use rog_aura::{GX502Layout, KeyColourArray, KeyLayout};
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let (dbus, _) = AuraDbusClient::new()?;

asusctl/src/anime_cli.rs

@@ -1,5 +1,5 @@
 use gumdrop::Options;
-use rog_types::error::AuraError;
+use rog_aura::error::Error;
 use std::str::FromStr;
 
 #[derive(Copy, Clone, Debug)]
@@ -8,7 +8,7 @@ pub enum AnimeStatusValue {
     Off,
 }
 impl FromStr for AnimeStatusValue {
-    type Err = AuraError;
+    type Err = Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         let s = s.to_lowercase();
@@ -17,7 +17,7 @@ impl FromStr for AnimeStatusValue {
             "off" => Ok(AnimeStatusValue::Off),
             _ => {
                 print!("Invalid argument, must be one of: on, off");
-                Err(AuraError::ParseAnime)
+                Err(Error::ParseAnime)
             }
         }
     }

asusctl/src/aura_cli.rs

@@ -1,8 +1,5 @@
 use gumdrop::Options;
-use rog_types::{
-    aura_modes::{AuraEffect, AuraModeNum, AuraZone, Colour, Direction, Speed},
-    error::AuraError,
-};
+use rog_aura::{AuraEffect, AuraModeNum, AuraZone, Colour, Direction, Speed, error::Error};
 use std::str::FromStr;
 
 #[derive(Options)]
@@ -19,7 +16,7 @@ impl LedBrightness {
     }
 }
 impl FromStr for LedBrightness {
-    type Err = AuraError;
+    type Err = Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         let s = s.to_lowercase();
@@ -30,7 +27,7 @@ impl FromStr for LedBrightness {
             "high" => Ok(LedBrightness { level: Some(0x03) }),
             _ => {
                 print!("Invalid argument, must be one of: off, low, med, high");
-                Err(AuraError::ParseBrightness)
+                Err(Error::ParseBrightness)
             }
         }
     }

asusctl/src/main.rs

@@ -6,8 +6,8 @@ use anime_cli::{AnimeActions, AnimeCommand};
 use gumdrop::{Opt, Options};
 use rog_anime::{AnimeDataBuffer, AnimeImage, Vec2, ANIME_DATA_LEN};
 use rog_dbus::AuraDbusClient;
+use rog_aura::{self, AuraEffect, AuraModeNum};
 use rog_types::{
-    aura_modes::{self, AuraEffect, AuraModeNum},
     gfx_vendors::GfxVendors,
     profile::{FanLevel, ProfileCommand, ProfileEvent},
     supported::{
@@ -215,7 +215,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
             Some(level) => dbus
                 .proxies()
                 .led()
-                .set_led_brightness(<aura_modes::LedBrightness>::from(level))?,
+                .set_led_brightness(<rog_aura::LedBrightness>::from(level))?,
         }
     }
 

daemon/Cargo.toml

@@ -19,6 +19,7 @@ path = "src/daemon.rs"
 
 [dependencies]
 rog_anime = { path = "../rog-anime" }
+rog_aura = { path = "../rog-aura" }
 rog_types = { path = "../rog-types" }
 rog_dbus = { path = "../rog-dbus" }
 rusb = "^0.8"

daemon/src/config_aura.rs

@@ -1,6 +1,6 @@
 use crate::laptops::LaptopLedData;
 use log::{error, info, warn};
-use rog_types::aura_modes::{AuraEffect, AuraModeNum, AuraMultiZone, AuraZone, LedBrightness};
+use rog_aura::{AuraEffect, AuraModeNum, AuraMultiZone, AuraZone, LedBrightness};
 use serde_derive::{Deserialize, Serialize};
 use std::collections::BTreeMap;
 use std::fs::{File, OpenOptions};

daemon/src/config_old.rs

@@ -1,4 +1,5 @@
-use rog_types::{aura_modes::AuraEffect, gfx_vendors::GfxVendors, profile::Profile};
+use rog_aura::AuraEffect;
+use rog_types::{gfx_vendors::GfxVendors, profile::Profile};
 use serde_derive::{Deserialize, Serialize};
 use std::collections::BTreeMap;
 

daemon/src/ctrl_leds.rs

@@ -1,7 +1,4 @@
 // Only these two packets must be 17 bytes
-static LED_APPLY: [u8; 17] = [0x5d, 0xb4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
-static LED_SET: [u8; 17] = [0x5d, 0xb5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
-
 static KBD_BRIGHT_PATH: &str = "/sys/class/leds/asus::kbd_backlight/brightness";
 
 use crate::{
@@ -10,7 +7,8 @@ use crate::{
     laptops::{LaptopLedData, ASUS_KEYBOARD_DEVICES},
 };
 use log::{error, info, warn};
-use rog_types::{LED_MSG_LEN, aura_modes::{AuraEffect, AuraModeNum, LedBrightness}, supported::LedSupportedFunctions};
+use rog_aura::{AuraEffect, AuraModeNum, LED_MSG_LEN, LedBrightness, usb::{LED_APPLY, LED_SET}};
+use rog_types::supported::LedSupportedFunctions;
 use std::fs::OpenOptions;
 use std::io::{Read, Write};
 use std::path::Path;

daemon/src/laptops.rs

@@ -1,5 +1,5 @@
 use log::{info, warn};
-use rog_types::aura_modes::AuraModeNum;
+use rog_aura::AuraModeNum;
 use serde_derive::{Deserialize, Serialize};
 use std::fs::OpenOptions;
 use std::io::Read;

rog-aura/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "rog_aura"
+version = "1.0.0"
+license = "MPL-2.0"
+readme = "README.md"
+authors = ["Luke <luke@ljones.dev>"]
+repository = "https://gitlab.com/asus-linux/asusctl"
+homepage = "https://gitlab.com/asus-linux/asusctl"
+documentation = "https://docs.rs/rog-anime"
+description = "Types useful for fancy keyboards on ASUS ROG laptops"
+keywords = ["ROG", "ASUS", "Aura"]
+edition = "2018"
+exclude = ["data"]
+
+[features]
+default = ["dbus"]
+dbus = ["zbus", "zvariant", "zvariant_derive"]
+
+[dependencies]
+serde = "^1.0"
+serde_derive = "^1.0"
+
+zbus = { version = "^1.9.1", optional = true }
+zvariant = { version = "^2.6", optional = true }
+zvariant_derive = { version = "^2.6", optional = true }

rog-aura/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

rog-aura/src/aura_modes.rs

@@ -1,15 +1,15 @@
-// static LED_INIT1: [u8; 2] = [0x5d, 0xb9];
-// static LED_INIT2: &str = "]ASUS Tech.Inc."; // ] == 0x5d
-// static LED_INIT3: [u8; 6] = [0x5d, 0x05, 0x20, 0x31, 0, 0x08];
-// static LED_INIT4: &str = "^ASUS Tech.Inc."; // ^ == 0x5e
-// static LED_INIT5: [u8; 6] = [0x5e, 0x05, 0x20, 0x31, 0, 0x08];
+pub const LED_INIT1: [u8; 2] = [0x5d, 0xb9];
+pub const LED_INIT2: &str = "]ASUS Tech.Inc."; // ] == 0x5d
+pub const LED_INIT3: [u8; 6] = [0x5d, 0x05, 0x20, 0x31, 0, 0x08];
+pub const LED_INIT4: &str = "^ASUS Tech.Inc."; // ^ == 0x5e
+pub const LED_INIT5: [u8; 6] = [0x5e, 0x05, 0x20, 0x31, 0, 0x08];
 
-use crate::error::AuraError;
-use crate::LED_MSG_LEN;
 use serde_derive::{Deserialize, Serialize};
 use std::str::FromStr;
 use zvariant_derive::Type;
 
+use crate::{LED_MSG_LEN, error::Error};
+
 #[derive(Debug, Copy, Clone, PartialEq, Deserialize, Serialize, Type)]
 pub enum LedBrightness {
     Off,
@@ -46,15 +46,15 @@ impl Default for Colour {
 }
 
 impl FromStr for Colour {
-    type Err = AuraError;
+    type Err = Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         if s.len() < 6 {
-            return Err(AuraError::ParseColour);
+            return Err(Error::ParseColour);
         }
-        let r = u8::from_str_radix(&s[0..2], 16).or(Err(AuraError::ParseColour))?;
-        let g = u8::from_str_radix(&s[2..4], 16).or(Err(AuraError::ParseColour))?;
-        let b = u8::from_str_radix(&s[4..6], 16).or(Err(AuraError::ParseColour))?;
+        let r = u8::from_str_radix(&s[0..2], 16).or(Err(Error::ParseColour))?;
+        let g = u8::from_str_radix(&s[2..4], 16).or(Err(Error::ParseColour))?;
+        let b = u8::from_str_radix(&s[4..6], 16).or(Err(Error::ParseColour))?;
         Ok(Colour(r, g, b))
     }
 }
@@ -71,7 +71,7 @@ impl Default for Speed {
     }
 }
 impl FromStr for Speed {
-    type Err = AuraError;
+    type Err = Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         let s = s.to_lowercase();
@@ -79,7 +79,7 @@ impl FromStr for Speed {
             "low" => Ok(Speed::Low),
             "med" => Ok(Speed::Med),
             "high" => Ok(Speed::High),
-            _ => Err(AuraError::ParseSpeed),
+            _ => Err(Error::ParseSpeed),
         }
     }
 }
@@ -100,7 +100,7 @@ impl Default for Direction {
     }
 }
 impl FromStr for Direction {
-    type Err = AuraError;
+    type Err = Error;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {
         let s = s.to_lowercase();
@@ -109,18 +109,11 @@ impl FromStr for Direction {
             "up" => Ok(Direction::Up),
             "down" => Ok(Direction::Down),
             "left" => Ok(Direction::Left),
-            _ => Err(AuraError::ParseDirection),
+            _ => Err(Error::ParseDirection),
         }
     }
 }
 
-/// Writes out the correct byte string for brightness
-pub const fn aura_brightness_bytes(brightness: u8) -> [u8; 17] {
-    [
-        0x5A, 0xBA, 0xC5, 0xC4, brightness, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-    ]
-}
-
 #[derive(
     Debug, Type, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Copy, Deserialize, Serialize,
 )]

rog-aura/src/data.rs

@@ -0,0 +1,73 @@
+use serde_derive::{Deserialize, Serialize};
+#[cfg(feature = "dbus")]
+use zvariant_derive::Type;
+
+/// The first 7 bytes of a USB packet are accounted for by `USB_PREFIX1` and `USB_PREFIX2`
+const BLOCK_START: usize = 7;
+/// *Not* inclusive, the byte before this is the final for each "pane"
+const BLOCK_END: usize = 634;
+/// Individual usable data length of each USB packet
+const PANE_LEN: usize = BLOCK_END - BLOCK_START;
+/// The length of usable data
+pub const ANIME_DATA_LEN: usize = PANE_LEN * 2;
+
+const USB_PREFIX1: [u8; 7] = [0x5e, 0xc0, 0x02, 0x01, 0x00, 0x73, 0x02];
+const USB_PREFIX2: [u8; 7] = [0x5e, 0xc0, 0x02, 0x74, 0x02, 0x73, 0x02];
+
+/// The minimal serializable data that can be transferred over wire types.
+/// Other data structures in `rog_anime` will convert to this.
+#[cfg_attr(feature = "dbus", derive(Type))]
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct AnimeDataBuffer(Vec<u8>);
+
+impl Default for AnimeDataBuffer {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl AnimeDataBuffer {
+    #[inline]
+    pub fn new() -> Self {
+        AnimeDataBuffer(vec![0u8; ANIME_DATA_LEN])
+    }
+
+    /// Get the inner data buffer
+    #[inline]
+    pub fn get(&self) -> &[u8] {
+        &self.0
+    }
+
+    /// Get a mutable slice of the inner buffer
+    #[inline]
+    pub fn get_mut(&mut self) -> &mut [u8] {
+        &mut self.0
+    }
+
+    /// Create from a vector of bytes
+    ///
+    /// # Panics
+    /// Will panic if the vector length is not `ANIME_DATA_LEN`
+    #[inline]
+    pub fn from_vec(input: Vec<u8>) -> Self {
+        assert_eq!(input.len(), ANIME_DATA_LEN);
+        Self(input)
+    }
+}
+
+/// The two packets to be written to USB
+pub type AnimePacketType = [[u8; 640]; 2];
+
+impl From<AnimeDataBuffer> for AnimePacketType {
+    #[inline]
+    fn from(anime: AnimeDataBuffer) -> Self {
+        assert!(anime.0.len() == ANIME_DATA_LEN);
+        let mut buffers = [[0; 640]; 2];
+        for (idx, chunk) in anime.0.as_slice().chunks(PANE_LEN).enumerate() {
+            buffers[idx][BLOCK_START..BLOCK_END].copy_from_slice(chunk);
+        }
+        buffers[0][..7].copy_from_slice(&USB_PREFIX1);
+        buffers[1][..7].copy_from_slice(&USB_PREFIX2);
+        buffers
+    }
+}

rog-aura/src/error.rs

@@ -0,0 +1,26 @@
+use std::error;
+use std::fmt;
+
+#[derive(Debug)]
+pub enum Error {
+    ParseColour,
+    ParseSpeed,
+    ParseDirection,
+    ParseBrightness,
+    ParseAnime,
+}
+
+impl fmt::Display for Error {
+    // This trait requires `fmt` with this exact signature.
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match self {
+            Error::ParseColour => write!(f, "Could not parse colour"),
+            Error::ParseSpeed => write!(f, "Could not parse speed"),
+            Error::ParseDirection => write!(f, "Could not parse direction"),
+            Error::ParseBrightness => write!(f, "Could not parse brightness"),
+            Error::ParseAnime => write!(f, "Could not parse anime"),
+        }
+    }
+}
+
+impl error::Error for Error {}

rog-aura/src/lib.rs

@@ -0,0 +1,21 @@
+/// The main data conversion for transfering in shortform over dbus or other,
+/// or writing directly to the USB device
+mod data;
+pub use data::*;
+
+/// A container of images/grids/gifs/pauses which can be iterated over to generate
+/// cool effects
+mod sequencer;
+pub use sequencer::*;
+
+mod aura_modes;
+pub use aura_modes::*;
+
+mod aura_perkey;
+pub use aura_perkey::*;
+
+pub mod usb;
+
+pub mod error;
+
+pub const LED_MSG_LEN: usize = 17;

rog-aura/src/sequencer.rs

@@ -0,0 +1,74 @@
+use std::{
+    path::{Path, PathBuf},
+    time::Duration,
+};
+
+use serde_derive::{Deserialize, Serialize};
+
+use crate::error::Error;
+
+/// All the possible AniMe actions that can be used. The enum is intended to be
+/// used in a array allowing the user to cycle through a series of actions.
+#[derive(Debug, Deserialize, Serialize)]
+pub enum ActionData {
+    Static
+}
+
+/// An optimised precomputed set of actions that the user can cycle through
+#[derive(Debug, Deserialize, Serialize, Default)]
+pub struct Sequences(Vec<ActionData>);
+
+impl Sequences {
+    #[inline]
+    pub fn new() -> Self {
+        Self(Vec::new())
+    }
+
+    /// Use a base `AnimeAction` to generate the precomputed data and insert in to
+    /// the run buffer
+    #[inline]
+    pub fn insert(&mut self, index: usize) -> Result<(), Error> {
+        Ok(())
+    }
+
+    /// Remove an item at this position from the run buffer. If the `index` supplied
+    /// is not in range then `None` is returned, otherwise the `ActionData` at that location
+    /// is yeeted and returned.
+    #[inline]
+    pub fn remove_item(&mut self, index: usize) -> Option<ActionData> {
+        if index < self.0.len() {
+            return Some(self.0.remove(index));
+        }
+        None
+    }
+
+    pub fn iter(&self) -> ActionIterator {
+        ActionIterator {
+            actions: &self,
+            next_idx: 0,
+        }
+    }
+}
+
+/// Iteractor helper for iterating over all the actions in `Sequences`
+pub struct ActionIterator<'a> {
+    actions: &'a Sequences,
+    next_idx: usize,
+}
+
+impl<'a> Iterator for ActionIterator<'a> {
+    type Item = &'a ActionData;
+
+    #[inline]
+    fn next(&mut self) -> Option<&'a ActionData> {
+        if self.next_idx == self.actions.0.len() {
+            self.next_idx = 0;
+            return None;
+        }
+
+        let current = self.next_idx;
+        self.next_idx += 1;
+
+        Some(&self.actions.0[current])
+    }
+}

rog-aura/src/usb.rs

@@ -0,0 +1,16 @@
+pub const LED_INIT1: [u8; 2] = [0x5d, 0xb9];
+pub const LED_INIT2: &str = "]ASUS Tech.Inc."; // ] == 0x5d
+pub const LED_INIT3: [u8; 6] = [0x5d, 0x05, 0x20, 0x31, 0, 0x08];
+pub const LED_INIT4: &str = "^ASUS Tech.Inc."; // ^ == 0x5e
+pub const LED_INIT5: [u8; 6] = [0x5e, 0x05, 0x20, 0x31, 0, 0x08];
+
+// Only these two packets must be 17 bytes
+pub const LED_APPLY: [u8; 17] = [0x5d, 0xb4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
+pub const LED_SET: [u8; 17] = [0x5d, 0xb5, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
+
+/// Writes out the correct byte string for brightness
+pub const fn aura_brightness_bytes(brightness: u8) -> [u8; 17] {
+    [
+        0x5A, 0xBA, 0xC5, 0xC4, brightness, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    ]
+}

rog-dbus/Cargo.toml

@@ -12,6 +12,7 @@ edition = "2018"
 [dependencies]
 serde_json = "^1.0"
 rog_anime = { path = "../rog-anime" }
+rog_aura = { path = "../rog-aura" }
 rog_types = { path = "../rog-types" }
 rog_fan_curve = { version = "^0.1", features = ["serde"] }
 zbus = "^1.8"

rog-dbus/src/lib.rs

@@ -1,7 +1,6 @@
 pub static DBUS_NAME: &str = "org.asuslinux.Daemon";
 pub static DBUS_PATH: &str = "/org/asuslinux/Daemon";
 pub static DBUS_IFACE: &str = "org.asuslinux.Daemon";
-pub const LED_MSG_LEN: usize = 17;
 
 pub mod zbus_anime;
 pub mod zbus_charge;
@@ -11,8 +10,8 @@ pub mod zbus_profile;
 pub mod zbus_rogbios;
 pub mod zbus_supported;
 
+use rog_aura::AuraEffect;
 use rog_types::{
-    aura_modes::AuraEffect,
     gfx_vendors::{GfxRequiredUserAction, GfxVendors},
 };
 use std::sync::{Arc, Mutex};

rog-dbus/src/zbus_led.rs

@@ -23,10 +23,7 @@ use std::sync::{Arc, Mutex};
 
 use zbus::{dbus_proxy, Connection, Result};
 
-use rog_types::{
-    aura_modes::{AuraEffect, LedBrightness},
-    aura_perkey::KeyColourArray,
-};
+use rog_aura::{AuraEffect, KeyColourArray, LedBrightness};
 
 const BLOCKING_TIME: u64 = 40; // 100ms = 10 FPS, max 50ms = 20 FPS, 40ms = 25 FPS
 

rog-types/Cargo.toml

@@ -11,6 +11,7 @@ edition = "2018"
 
 [dependencies]
 gumdrop = "^0.8"
+rog_aura = { path = "../rog-aura" }
 rog_fan_curve = { version = "^0.1", features = ["serde"] }
 serde = "^1.0"
 serde_derive = "^1.0"

rog-types/src/error.rs

@@ -1,30 +1,6 @@
 use std::error::Error;
 use std::fmt;
 
-#[derive(Debug)]
-pub enum AuraError {
-    ParseColour,
-    ParseSpeed,
-    ParseDirection,
-    ParseBrightness,
-    ParseAnime,
-}
-
-impl fmt::Display for AuraError {
-    // This trait requires `fmt` with this exact signature.
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        match self {
-            AuraError::ParseColour => write!(f, "Could not parse colour"),
-            AuraError::ParseSpeed => write!(f, "Could not parse speed"),
-            AuraError::ParseDirection => write!(f, "Could not parse direction"),
-            AuraError::ParseBrightness => write!(f, "Could not parse brightness"),
-            AuraError::ParseAnime => write!(f, "Could not parse anime"),
-        }
-    }
-}
-
-impl Error for AuraError {}
-
 #[derive(Debug)]
 pub enum GraphicsError {
     ParseVendor,

rog-types/src/lib.rs

@@ -5,15 +5,9 @@
 pub static DBUS_NAME: &str = "org.asuslinux.Daemon";
 pub static DBUS_PATH: &str = "/org/asuslinux/Daemon";
 pub static DBUS_IFACE: &str = "org.asuslinux.Daemon";
-pub const LED_MSG_LEN: usize = 17;
-
-pub mod aura_modes;
 
 pub mod profile;
 
-/// Enables you to create fancy RGB effects
-pub mod aura_perkey;
-
 pub mod gfx_vendors;
 
 pub mod supported;

rog-types/src/supported.rs

@@ -1,7 +1,6 @@
+use rog_aura::AuraModeNum;
 use serde_derive::{Deserialize, Serialize};
 
-use crate::aura_modes::AuraModeNum;
-
 #[derive(Serialize, Deserialize)]
 pub struct SupportedFunctions {
     pub anime_ctrl: AnimeSupportedFunctions,