KOR - Synthetic RLV Controllers
  • 🔴Welcome to KOR - A Line of SL Synthetic Controllers
  • Overview
    • ❓What is KOR?
    • ✨Our Features
    • 🆘Need Help?
    • ❔F.A.Q
  • Getting Started
    • ⭐Ready to Begin?
    • 📕Command Reference
    • 🔑RLV Ownership Functions
      • KOR Permission System
    • 📄Menu Structure
      • Subsystems
      • Core
        • Filters
        • Personas
      • Follow
      • Devices
      • Report
      • Manage
        • Colors
        • Users
        • RLV Relay
        • Designation
  • General Information
    • Updating the System
    • Profiles AKA Cold-Swapping
    • KOR HUD
      • User Interface
    • Model Numbers (Serials)
  • Secondary Systems (Optional)
    • KOR Display Case
    • KOR Capacitive Charger
    • KOR Overhead
    • H.E.R.O (Combat System)
    • Arousal System
    • Auxiliary Power
  • KOR Controllers
    • KOR Cassette Tape Module
    • KOR Floppy Disk Module
    • KOR Helix
    • KOR Trailblazer
    • KOR Prisma
    • KOR Echo
    • KOR Nexus Key
    • KOR BYOC (Build Your Own Controller)
  • Development
    • Release Notes
    • Current Progress
    • ACS Protocol
    • KOR API
      • Fetch Segments
    • Charging
      • What is Efficacy?
    • Example Scripts
Powered by GitBook
On this page
  • "colors"
  • "identify"
  • "devices"
  • "subsystems"
  1. Development
  2. KOR API

Fetch Segments

Important Note: The information on this page is subject to change as the API evolves. Please build in flexibility to accommodate potential updates.

Each segment name or JSON object will be specified in response by key with returned value. Fetch segments as JSON objects can specify "include"/"exclude" params to limit the data that can be returned.

"colors"

  • color: Main system color

  • color-2: Secondary color

  • color-3: Tertiary color

  • color-4: Quaternary color

Example
{"colors":{"color":"<1.00000, 0.00000, 0.00000>","color-2":"<0.56000, 0.87500, 1.00000>","color-3":"<1.00000, 0.00000, 0.00000>","color-4":"<1.00000, 0.00000, 0.00000>"}}

"identify"

  • id: Uniquely assigned controller identifier

  • serial: KOR assigned Unit Serial

  • controller: Controller currently active

Example
{"identify":{"id":"1444f86e-43ef-c7ad-674c-03166ab5198e","serial":"KOR-50B-00-2705","controller":"Echo"}}

"devices"

All Devices:

  • uuid: Object Root

  • deviceName: Object Name

  • thermalStat: Thermals applied (managed by HVAC)

  • powerRate: Power utilized by device

  • isNanite: True if device was added via Lightbus

Power Devices

  • charge: Current charge value in Joules

  • chargeCapacity: Maximum charge value in Joules

  • powerType: Plasma/Battery/Tension

Example
{"devices": [{"uuid":"b380fa85-3349-477d-5a60-0c21c33c71f0","deviceName":"Plasma Power Cell","thermalStat":{"objectMass":12,"energyJoules":20892,"temperature":0.9076666666666514},"powerRate":0,"isNanite":true,"charge":72875234,"chargeCapacity":85196800,"powerType":"Plasma"}]}

"subsystems"

  • id: Subsystem identifier

  • systemName: Subsystem label/name

  • running: True if subsystem is active

  • powerRate: Joules per second

Example
{"subsystems": {"id":"subsys.audio","label":"Audio","running":true,"power":38}}
PreviousKOR APINextCharging

Last updated 1 year ago