Git Product home page Git Product logo

api's Introduction

Spacetime's APIs

Spacetime has 2 APIs:

  • The Northbound Interface (NBI) allows humans or applications to define and orchestrate a network. This includes functions such as specifying the time-dynamic position and orientation of platforms and antennas, defining networking parameters on each node in the network, and creating requests for service that will be scheduled and routed through the network.
  • The Control to Data-plane Interface (CDPI), or Southbound Interface, allows Spacetime to control network devices and receive updates in return. This includes functions such as steering antenna beams to establish new links and configuring RF parameters like the transmit power and channel.

Developer Guides

You can find developer guides and tutorials on this website.

This site contains:

Repo Contents

In this repo, you will find the following directories:

  • api: The gRPC and Protocol Buffers definitions of the API.
  • agent: A Go implementation of an SBI agent.
  • contrib: An open-source directory of real hardware that has been modeled in Spacetime and used in real networks. Contributions are welcome!

Contributing

Spacetime welcomes contributions to its APIs. Read the governance document to learn more about policies and processes for suggesting changes to the APIs.

License

Spacetime's APIs are licensed under Apache 2.0 (see the LICENSE file).

api's People

Contributors

nihar-aalyria avatar ciarand avatar dgnemo avatar helen-aalyria avatar hiroki-aalyria avatar henry-aalyria avatar ek345 avatar davidmandle avatar

Stargazers

Oliver Fletcher avatar John Dacquisto avatar TJKoury avatar kcallaghan-arcfield avatar Shin avatar Radu Topala avatar Nicolas Hennion avatar  avatar Lucas Resch avatar  avatar nickel0 avatar Shunichiro Nomura avatar Chris avatar  avatar  avatar

Watchers

Nicole (Nikki) VonHollen avatar  avatar  avatar Frank Stoner avatar Mark Bradley avatar Brian Barritt avatar  avatar  avatar

api's Issues

Consider contributing to SpaceDataStandards.org

Great work, impressive project and capability.

Converged comms is something civil and military programs have struggled with for years, and I think you have something here that offers a more open, modular solution.

I ask that you check out SpaceDataStandards.org, and see if we can merge the message schemas you are using with the standards under development.

Also, Flatbuffers have OOTB support for gRPC, though I’m less concerned with the serialization format than deconflicting message types for interoperability.

Improve `nbictl --help` output

After building nbictl via Bazel (which is undocumented) and configuring the CLI to connect to our instance I wanted to see what else it does without consulting the repository:

nbictl --help
Usage of nbictl:

Apparently nothing. For other commands it does provide some usage information:

nbictl list --help
Usage of nbictl list:
  -context string
        name of context you want to use
  -type string
        [REQUIRED] type of entities you want to query. list of possible types: [PLATFORM_DEFINITION PROPAGATION_WEATHER TRANSCEIVER_LINK_REPORT COMPUTED_MOTION INTERFERENCE_CONSTRAINT MOTION_DEFINITION INTERFACE_LINK_REPORT SERVICE_REQUEST DRAIN_PROVISION INTENT NETWORK_NODE CDPI_STREAM_INFO SURFACE_REGION DEVICES_IN_REGION STATION_SET NETWORK_STATS_REPORT ANTENNA_PATTERN BAND_PROFILE]

Create README.md

When a new developer opens https://github.com/aalyria/api, they are greeted with a fairly stark codebase. It's not immediately obvious what the code is, how to build it, now to use it etc.

Consider either moving /api/getting-started.md to /README.md (noting the capitalisation), or else create a new /README.md explaining the repository.

Installation/Build instruction

Hi,

I'm interested in playing around with the NBI API, but the build instructions appear to be blank, and I can't see to find any instructions on installing it.

Where should I be looking? I don't see anything on the website, either.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.