Welcome to VICINITY Get Started’s documentation!

Contents:

• Get started
  • Install the VICINITY Gateway API from GitHub
  • Run the VICINITY Gateway API as a service
  • Install the VICINITY Example Adapter
  • Install the VICINITY Agent Service
  • Register your things
  • Read data from your example thing
• VICINITY Overall architecture
  • VICINITY Cloud
  • VICINITY Node
  • How to connect IoT infrastructure to VICINITY
  • How to integrate IoT infrastructure in VICINITY
• VICINITY Open Gateway API
  • Introduction
  • 1 Open Gateway API overview
  • 2 Open Gateway API installation and configuration
    • 2.1 Installation
      • 2.1.1 Linux / Unix – installation from the Git repository
        • 2.1.1.1 Cloning the repository
        • 2.1.1.2 Building the OGWAPI from source codes
        • 2.1.1.3 Creating a dedicated system user
        • 2.1.1.4 Putting it all in the right place
      • 2.1.2 Linux – .deb installation package
      • 2.1.3 Linux - .rpm installation package
      • 2.1.4 MacOS
      • 2.1.5 Windows
      • 2.1.6 Docker
    • 2.2 Configuration
      • 2.2.1 Some notes on how the configuration is read
      • 2.2.2 Basic configuration
      • 2.2.3 List of configuration parameters and their meaning
      • 2.2.4 Uploading your SSH key to the Neighbourhood Manager
    • 2.3 Running the OGWAPI
    • 2.3.1 Run the VICINITY Gateway API as a service
    • 2.4 Updating an existing installation of OGWAPI
  • 3 Using Open Gateway API
    • 3.1 Interfaces overview
    • 3.2 Using HTTPS on OGWAPI
      • 3.2.1 Enabling HTTPS on OGWAPI
      • 3.2.2 Configuring OGWAPI to use HTTPS provided by Agent / Adapter
    • 3.3 Testing and debugging
      • 3.3.1 Error propagation
    • 3.4 Object discovery and registration
    • 3.5 Data consumption
    • 3.6 Exposing your IoT objects
    • 3.7 Search and querying the network
    • 3.8 Complete description of Open Gateway API endpoints
  • 4 Integration and adapter development
    • 4.1 Consumption interface integration
      • 4.1.1 Properties
        • 4.1.1.1 Providing a property
        • 4.1.1.2 Setting a property
      • 4.1.2 Actions
        • 4.1.2.1 Starting an execution
        • 4.1.2.2 Cancelling an ongoing execution
    • 4.2 Exposing interface integration
      • 4.2.1 Receive an event
  • 5 Frequently asked questions
• VICINITY Neighbourhood Manager
  • Introduction
  • Platform deployment
    • Pre-requisites
    • Get the application
    • Run the client
    • Run the server
    • Putting all together – First user and organisation in the app
    • Additional info
  • Platform Introduction
    • Architecture
    • Platform Overview
      • Login
      • Registration
      • Home
    • Quick Start
      • Pre-requisites
      • First login
      • Create an access point
      • Next steps
  • Registration
    • Register an organisation
    • Invite an organisation or user
    • Quick registration for API developers
  • Organisation and user management
    • Organisation properties
      • Properties
      • Relationships
    • User properties and roles
      • Properties
      • Relationships
      • Roles
    • Organisation management
      • Organisations view
      • Friendships
      • Remove organisation
    • User management
      • Remove user
      • Change roles
  • Infrastructure Management
    • Access Points
      • Properties
      • Relationships
      • Manage
    • Items
      • Properties
      • Relationships
      • Manage
      • Status & visibility
      • Move an item
    • Contracts
      • Properties
      • Relationships
      • Main views
      • Manage
      • Update items in the contract
  • Platform Evaluation
    • Tests
    • Complexity
  • F.A.Q
    • How can I recover my password?
    • How can I change my password?
    • Can I keep a session open in my browser?
    • How can I use the platform REST API?
• VICINITY Vocabulary

Indices and tables

• Index
• Module Index
• Search Page