https://github.com/eclipse-zenoh/zenoh-go

Go-lang API for zenoh
https://github.com/eclipse-zenoh/zenoh-go

edge-computing go golang iot zenoh

Last synced: 1 day ago
JSON representation

Go-lang API for zenoh

• Host: GitHub
• URL: https://github.com/eclipse-zenoh/zenoh-go
• Owner: eclipse-zenoh
• License: other
• Created: 2020-01-21T15:43:00.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-01-12T10:10:07.000Z (10 months ago)
• Last Synced: 2024-06-20T15:50:54.001Z (5 months ago)
• Topics: edge-computing, go, golang, iot, zenoh
• Language: Go
• Homepage: http://zenoh.io
• Size: 112 KB
• Stars: 14
• Watchers: 10
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![zenoh banner](./zenoh-dragon.png)

![Build](https://github.com/eclipse-zenoh/zenoh-go/workflows/Go/badge.svg)

[![GoReport Status](https://goreportcard.com/badge/github.com/eclipse-zenoh/zenoh-go)](https://goreportcard.com/report/github.com/eclipse-zenoh/zenoh-go)

[![Documentation Status](https://readthedocs.org/projects/zenoh-go/badge/?version=latest)](https://zenoh-go.readthedocs.io/en/latest/?badge=latest)

[![Gitter](https://badges.gitter.im/atolab/zenoh.svg)](https://gitter.im/atolab/zenoh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# Eclipse zenoh Go API

[Eclipse zenoh](http://zenoh.io) is an extremely efficient and fault-tolerant [Named Data Networking](http://named-data.net) (NDN) protocol 

that is able to scale down to extremely constrainded devices and networks. 

:warning: **zenoh has been subjet to a complete rewrite with major protocol updates between versions 0.4.2 and 0.5.0. The Go API does not yet integrate those changes and is only compatible with version 0.4.2 of the zenoh daemon and the underlying zenoh-c stack.**

The Go API is for pure clients, in other terms does not support peer-to-peer communication, can be easily tested against a zenoh router running in a Docker container (see https://github.com/eclipse-zenoh/zenoh#how-to-test-it). 

-------------------------------

## How to install it

The zenoh-go library relies on the zenoh-c library. Please install it, either [installing the **libzenohc-dev** package](https://github.com/eclipse-zenoh/zenoh-c#how-to-install-it), either [building zenoh-c](https://github.com/eclipse-zenoh/zenoh-c#how-to-build-it) by yourself

Supported Go version: **1.14.0** minimum.

Install the zenoh-go library via the usual `go get`command:

  ```bash

  $ go get github.com/eclipse-zenoh/zenoh-go

  ```

-------------------------------

## Running the Examples

The simplest way to run some of the example is to get a Docker image of the **zenoh** network router (see https://github.com/eclipse-zenoh/zenoh#how-to-test-it) and then to run the examples on your machine.

Then, run the zenoh-go examples following the instructions in [examples/zenoh/README.md](https://github.com/eclipse-zenoh/zenoh-go/blob/master/examples/zenoh/README.md)