3.00: Animus Documentation for Developers

3.00: Animus Documentation

This page contains technical documentation for each file and method within the core Animus driver. This series of pages are designed for developers that are looking to work on Animus itself (Devs), for people who wish to use Animus for their own keyboard project (Users), please visit the How to use page.

Contents

• 3.10: animus_main.ino
  • 3.11: void Setup()
  • 3.12: void Loop()
  • 3.13: void PressKey(char val, byte type)
  • 3.14: void ReleaseKey(char val, byte type)
  • 3.15: void ReleaseAllKey()
  • 3.16: void SwitchLayer(boolean increment)
  • 3.17: void RotateLayers(byte val)
  • 3.18: void ResetPins()
  • 3.19: void KeyScan()
• 3.20: animus.ino
  • 3.21: Global variable and precompiler directives
• 3.30: EEPROM.ino
  • 3.31: void SetEEPROM(int x, int y, int z, char inputChar, byte inputType)
  • 3.32: int GetLayEEPROM()
  • 3.33: char GetValEEPROM(int x, int y, int z)
  • 3.34: byte GetTypeEEPROM(int x, int y, int z)
  • 3.35: int GetEEPROMValue(int x, int y, int z)
• 3.40: millis.ino
  • 3.41: void MillisLoop()
  • 3.42: boolean CheckMillis()
• 3.50: mod.ino
  • 3.51: void ModStartup()
  • 3.52: void ModLoop()
  • 3.53: void ModKeyDown(char val, byte type)
  • 3.54: void ModKeyUp(char val, byte type)
  • 3.55: void ModSerial(String input)
• 3.60: nkro.ino
  • 3.61: void NKROStartup()
  • 3.62: void NKROKeyDown(char val, byte type)
  • 3.63: void NKROSetMode(int val)
  • 3.64: void NKROSerial(String input)
• 3.70: serial.ino
  • 3.71: void TestSerial()
  • 3.72: void SerialCommand(String input)
• 3.80: AnimusKeyboard.cpp
• 3.90: AnimusKeyboard.h