class PlaceOS::Api::Edges

• PlaceOS::Api::Edges
• PlaceOS::Api::Application
• ActionController::Base
• Reference
• Object

Defined in:

Constant Summary

Log = ::PlaceOS::Api::Log.for(self)

PARSER_LIST = ["application/json"]

RESPONDER_LIST = ["application/json"]

ROUTE_RESOURCE = "edges"

Class Method Summary

• .base_route

  Helper for obtaining base route

• .connection_manager : ConnectionManager
• .edge_control(hash_parts : Hash(String | Symbol, Nil | Bool | Int32 | Int64 | Float32 | Float64 | String | Symbol) | Nil = nil, **tuple_parts)

  Helper methods for performing redirect_to calls

Macro Summary

• generate_scope_check(*scopes)

Instance Method Summary

• #base_route(*args, **options)

  Helper for obtaining base route

• #base_route(*args, **options, &)

  Helper for obtaining base route

• #create(create_body : PlaceOS::Model::Edge::CreateBody) : PlaceOS::Model::Edge::KeyResponse

  add a new edge location

• #current_edge : PlaceOS::Model::Edge
• #current_edge? : PlaceOS::Model::Edge | Nil
• #destroy : Nil

  remove an edge location

• #edge_control(socket) : Nil

  the websocket endpoint that edge devices use to connect to the cluster

• #find_current_edge(id : String)
• #index : Array(PlaceOS::Model::Edge)

  list the edges in the system.

• #show : PlaceOS::Model::Edge

  return the details of an edge location

• #token : NamedTuple(token: String)

  admins can obtain the token edge nodes will use to connect to the cluster

• #update(edge : PlaceOS::Model::Edge) : PlaceOS::Model::Edge

  update the details of an edge location

Class Method Detail

Macro Detail

Instance Method Detail