Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 2.44 KB

README.md

File metadata and controls

41 lines (23 loc) · 2.44 KB
Raw

Sofia2 C API

Read this in other languages: English, Spanish.

Copyright notice

© 2013-15 Indra Sistemas S.A., Carlo Gavazzi Automation S.p.A., Circutor S.A.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

API documentation

The documentation of the C API is published at http://sofia2.github.io/c-api/.

Before using the SSAP API for the first time, we strongly recommend that you learn the main concepts of the Sofia2 platform. They have been included in the Sofia2 developer documentation, which can be downloaded from http://sofia2.com/desarrollador_en.html.

The folder examples contains usage examples of the whole API. These examples are automatically compiled during the project build, and make use of the Sofia2 experimentation instance (http://sofia2.com).

If you want to test this API, we encourage you to register here, to create your own ontologies and client applications and to modify the examples as much as you wish.

Repository contents

This repository contains the following directories:

  • paho-mqtt-c: this directory contains the Eclipse Paho C MQTT client library.
  • cjson: this directory contains a library to manipulate JSON objects from C code. You should use it to manipulate the SSAP messages generated by the API.
  • ssap: this directory contains the SSAP C API itself.
  • [Windows Build](Windows Build): this directory contains a Microsoft Visual Studio 2013 solution that builds the SSAP API DLL files and the examples.
  • examples: this directory contains usage examples of the whole API. These examples are also integrated in the examples section of the API documentation.

Contact information

If you need support from us, please feel free to contact us at plataformasofia2@indra.es or at www.sofia2.com.

And if you want to contribute, send us a pull request.

Installation instructions

See the API documentation (http://sofia2.github.io/c-api/).