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:

  • GNode: Default value

  • TerminalAsset: An avatar for a real-word Transactive Device. [More Info](https://gridworks.readthedocs.io/en/latest/transactive-device.html).

  • AtomicTNode: Transacts in markets on behalf of, and controlling the power use of, a TerminalAsset

  • MarketMaker: Runs energy markets at its Node in the GNodeTree

  • AtomicMeteringNode: Role of a GNode that will become an AtomicTNode, prior to it owning TaTradingRights

  • ConductorTopologyNode: An avatar for a real-world electric grid node - e.g. a substation or transformer

  • InterconnectionComponent: An avatar for a cable or wire on the electric grid

  • World: Adminstrative GNode responsible for managing and authorizing instances

  • TimeCoordinator: Responsible for managing time in simulations

  • Supervisor: Responsible for GNode actors running in a container

  • Scada: GNode associated to the device and code that directly monitors and actuates a Transactive Device

  • PriceService: Provides price forecasts for markets run by MarketMakers

  • WeatherService: Provides weather forecasts

  • AggregatedTNode: An aggregation of AtomicTNodes

  • Persister: Responsible for acking events with delivery guarantees

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:

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]