GridWorks Enums

GwSchema Enums used in gridworks

class gridworks.enums.AlgoCertType(value)

Used to distinguish ASA vs SmartSignature certificates

Choices and descriptions:

  • ASA: Certificate based on Algorand Standard Asset

  • SmartSig: Certificate based on Algorand Smart Signature

classmethod default()

Returns default value ASA

Return type:

AlgoCertType

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.CoreGNodeRole(value)

CoreGNodeRole assigned by GNodeFactory. [More Info](https://gridworks.readthedocs.io/en/latest/core-g-node-role.html).

Choices and descriptions:

  • Other:

  • TerminalAsset:

  • AtomicTNode:

  • MarketMaker:

  • AtomicMeteringNode:

  • ConductorTopologyNode:

  • InterconnectionComponent:

  • Scada:

classmethod default()

Returns default value Other

Return type:

CoreGNodeRole

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.GNodeRole(value)

Categorizes GNodes by their function within GridWorks. [More Info](https://gridworks.readthedocs.io/en/latest/g-node-role.html).

Choices and descriptions:

classmethod default()

Returns default value GNode

Return type:

GNodeRole

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.GNodeStatus(value)

Enum for managing GNode lifecycle. [More Info](https://gridworks.readthedocs.io/en/latest/g-node-status.html).

Choices and descriptions:

  • Unknown: Default value

  • Pending: The GNode exists but cannot be used yet.

  • Active: The GNode can be used.

  • PermanentlyDeactivated: The GNode can no longer be used, now or in the future.

  • Suspended: The GNode cannot be used, but may become active in the future.

classmethod default()

Returns default value Unknown

Return type:

GNodeStatus

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.GniStatus(value)

Enum for managing GNodeInstance lifecycle. [More Info](https://gridworks.readthedocs.io/en/latest/g-node-instance.html).

Choices and descriptions:

  • Unknown: Default Value

  • Pending: Has been created by the World, but has not yet finished provisioning

  • Active: Active in its GridWorks world. If the GNodeInstance has an actor, that actor is communicating

  • Done: No longer represents the GNode.

classmethod default()

Returns default value Unknown

Return type:

GniStatus

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.MarketPriceUnit(value)

Price unit assigned to MarketMaker MarketType

Choices and descriptions:

  • USDPerMWh:

classmethod default()

Returns default value USDPerMWh

Return type:

MarketPriceUnit

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.MarketQuantityUnit(value)

Quantity unit assigned to MarketMaker MarketType

Choices and descriptions:

  • AvgMW:

  • AvgkW:

classmethod default()

Returns default value AvgMW

Return type:

MarketQuantityUnit

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.MarketTypeName(value)

Categorizes different markets run by MarketMaker

Choices and descriptions:

  • unknown: Default unknown

  • rt5gate5: Real-time energy, 5 minute MarketSlots, gate closing 5 minutes prior to start

  • rt60gate5: Real-time energy, 60 minute MarketSlots, gate closing 5 minutes prior to start

  • da60: Day-ahead energy, 60 minute MarketSlots

  • rt60gate30: Real-time energy, 60 minute MarketSlots, gate closing 30 minutes prior to start

  • rt15gate5: Real-time energy, 15 minute MarketSlots, gate closing 5 minutes prior to start

  • rt30gate5: Real-time energy, 30 minute MarketSlots, gate closing 5 minutes prior to start

  • rt60gate30b: Real-time energy, 30 minute MarketSlots, gate closing 5 minutes prior to start, QuantityUnit AvgkW

classmethod default()

Returns default value unknown

Return type:

MarketTypeName

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.MessageCategory(value)

Categorizes how GridWorks messages are sent and decoded/encoded

Choices and descriptions:

  • Unknown: Default value

  • RabbitJsonDirect: Serialized Json message sent on the world rabbit broker from one GNode actor to another

  • RabbitJsonBroadcast: Serailized Json message broadcast on the world rabbit broker by a GNode actor

  • RabbitGwSerial: GwSerial protocol message sent on the world rabbit broker

  • MqttJsonBroadcast: Serialized Json message following MQTT topic format, sent on the world rabbit broker

  • RestApiPost: REST API post

  • RestApiPostResponse: REST API post response

  • RestApiGet: REST API GET

classmethod default()

Returns default value Unknown

Return type:

MessageCategory

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.MessageCategorySymbol(value)

Shorthand symbols for MessageCategory000 Enum, used in meta-data like routing keys

Choices and descriptions:

  • unknown: Default value

  • rj: Serialized Json message sent on the world rabbit broker from one GNode actor to another

  • rjb: Serailized Json message broadcast on the world rabbit broker by a GNode actor

  • s: GwSerial protocol message sent on the world rabbit broker

  • gw: Serialized Json message following MQTT topic format, sent on the world rabbit broker

  • post: REST API post

  • postack: REST API post response

  • get: REST API GET

classmethod default()

Returns default value unknown

Return type:

MessageCategorySymbol

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.RecognizedCurrencyUnit(value)

Unit of currency

Choices and descriptions:

  • Unknown:

  • USD: US Dollar

  • GBP: Pounds sterling

classmethod default()

Returns default value UNKNOWN

Return type:

RecognizedCurrencyUnit

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.StrategyName(value)

Used to assign code to run a particular GNodeInstance

Choices and descriptions:

  • NoActor: Assigned to GNodes that do not have actors

  • WorldA: Authority on GNodeInstances, and their private keys. Maintains a FastAPI used for relational information about backoffice information held locally and/or in the GNodeRegistry/GNodeFactory. [More Info](https://gridworks.readthedocs.io/en/latest/world-role.html)

  • SupervisorA: A simple supervisor that monitors its supervised AtomicTNode GNode strategies via a heartbeat health check. [More Info](https://gridworks.readthedocs.io/en/latest/supervisor.html)

  • AtnHeatPumpWithBoostStore: AtomicTNode for a heat pump thermal storage heating system with a boost element and a thermal

heated by the boost element. [More on AtomicTNodes](https://gridworks.readthedocs.io/en/latest/atomic-t-node.html)

  • TcGlobalA: Used to manage the global time of the Gridworks system when run with

in a fully simulated universe. [More on TimeCoordinators](https://gridworks.readthedocs.io/en/latest/time-coordinator.html)

  • MarketMakerA: Runs a two-sided market associated to its GNode as part of the copper GNode sub-tree. [More on MarketMakers](https://gridworks.readthedocs.io/en/latest/market-maker.html)

  • AtnBrickStorageHeater: Publicly available Dijkstra-based AtomicTNode strategy for a brick storage heater. These heaters are rooom units that store heat in a brick core, are heated with resistive elements, and typically have a fan to blow air over the brick core. They are sometimes called Electric Thermal Storage (ETS) heaters, and in the UK are often called Economy 7 heaters or Night Storage Heaters. A strategy very similar to this was used by VCharge to manage an ETS fleet of several thousand heaters in Pennsylvania. This strategy is meant to serve as a template for other private strategies, and also allows for an end-to-end simulation of a realistic aggregated transactive load capable of generating a highly elastic bid curve [More Info](https://gridworks-atn.readthedocs.io/en/latest/brick-storage-heater.html)

classmethod default()

Returns default value NoActor

Return type:

StrategyName

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.SupervisorContainerStatus(value)

Manages lifecycle of the docker containers where GridWorks actors run

Choices and descriptions:

  • Unknown: Default value

  • Authorized: World has created the information for starting the container

  • Launching: World has launched the container

  • Provisioning: Container has started, but is going through its provisioning process

  • Running: GNode actors in the container are active

  • Stopped: Stopped

  • Deleted: Deleted

classmethod default()

Returns default value Unknown

Return type:

SupervisorContainerStatus

classmethod values()

Returns enum choices

Return type:

List[str]

class gridworks.enums.UniverseType(value)

Allows for multiple GridWorks, in particular for development and shared simulations. [More Info](https://gridworks.readthedocs.io/en/latest/universe.html).

Choices and descriptions:

  • Dev: Simulation running on a single computer.

  • Hybrid: Anything goes.

  • Production: Money at stake.

classmethod default()

Returns default value Dev

Return type:

UniverseType

classmethod values()

Returns enum choices

Return type:

List[str]