https://github.com/telefonicaid/perseo-fe
Front End process for the Perseo CEP
https://github.com/telefonicaid/perseo-fe
Last synced: 10 days ago
JSON representation
Front End process for the Perseo CEP
- Host: GitHub
- URL: https://github.com/telefonicaid/perseo-fe
- Owner: telefonicaid
- License: agpl-3.0
- Created: 2015-01-20T10:05:37.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T09:58:31.000Z (3 months ago)
- Last Synced: 2025-01-20T10:26:31.549Z (3 months ago)
- Language: JavaScript
- Size: 2.8 MB
- Stars: 15
- Watchers: 18
- Forks: 29
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES_NEXT_RELEASE
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# Perseo Context-Aware CEP
[](https://www.fiware.org/developers/catalogue/)
[](./LICENSE)
[](https://stackoverflow.com/questions/tagged/fiware-perseo)
[](https://quay.io/repository/fiware/perseo-fe)
[](https://hub.docker.com/r/telefonicaiot/perseo-fe)
[](https://fiware-perseo-fe.readthedocs.io/en/latest/)
[](https://github.com/telefonicaid/perseo-fe/actions?query=workflow%3ACI)
[](https://coveralls.io/github/telefonicaid/perseo-fe?branch=master)
[](https://bestpractices.coreinfrastructure.org/projects/5597)
## Overview
Perseo is a Complex Event Processing (CEP) software designed to be fully _NGSI-v2_-compliant. It uses NGSI-v2 as the
communication protocol for events, and thus, Perseo is able to seamless and jointly work with _context brokers_. The
context broker tested with Perseo and officially supported is
[Orion Context Broker](https://github.com/telefonicaid/fiware-orion).
This project is part of [FIWARE](https://www.fiware.org). You can find more FIWARE components in the
[FIWARE catalogue](https://catalogue.fiware.org).
| :books: [Documentation](https://fiware-perseo-fe.readthedocs.io/en/latest/) | 
[quay.io](https://quay.io/repository/fiware/perseo-fe) | :whale: [Docker Hub](https://hub.docker.com/r/telefonicaiot/perseo-fe/) | :dart: [Roadmap](documentation/roadmap.md) |
| ---------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------ | --- |
## Content
- [Background](#background)
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Contributing](#Contributing)
- [Testing](#testing)
- [More Information](#more-information)
- [License](#license)
## Background
Perseo is an [Esper-based](http://www.espertech.com/esper/) Complex Event Processing (CEP) software designed to be fully
_NGSI-v2_-compliant.
It follows a straightforward idea: listening to events coming from context information to identify patterns described by
rules, in order to immediately react upon them by triggering actions.
By leveraging on the
[notifications mechanism](http://fiware-orion.readthedocs.io/en/latest/user/walkthrough_apiv2/index.html#subscriptions),
clients instruct Orion CB to notify Perseo of the changes in the entities they care about (`Event API`). Details of this
process are explained in the [Orion Subscription part of the User Manual](user/index.md#orion-subscription). Then, rules
to the CORE Rule Engine can be easily managed using the publicly available
[WireCloud](https://github.com/Wirecloud/wirecloud)) operational dashboard, or making use of any of the REST clients
able to programmaticly use the Perseo's `Rule API`. These rules will identify patterns that will trigger actions with
Orion to create or update entities, or with other different components or external systems, such as Web (HTTP), Email
(SMTP) or SMS (SMPP) servers.
## Installation
The instructions to install Perseo can be found in the [Deployment Guide](docs/admin/deployment.md)
## Usage
Information about how to use Perseo can be found in the [User & Programmers Manual](docs/user/index.md)
## API
APIs and examples of their usage can be found [here](docs/API/api.md)
## Contributing
Contributions to this project are welcome. Developers planning to contribute should follow the
[Contribution Guidelines](docs/developer/contributing.md). If you plan to contribute, please also read the
[Development documentation](docs/developer/development.md).
## Testing
For performing a basic end-to-end test, you can follow the detailed instructions
[here](docs/developer/development.md#Testing).
## More Information
- Refer to the
[Esper Reference Documentation](http://esper.espertech.com/release-8.4.0/reference-esper/html/index.html) for info
on how to use EPL as a rule language.
- [Full Perseo documentation](docs/README.md)
## License
Perseo FE is licensed under [Affero General Public License (GPL) version 3](./LICENSE).
### Are there any legal issues with AGPL 3.0? Is it safe for me to use?
There is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly
related with the fact that different people assign different interpretations on the meaning of the term “derivate work”
used in these licenses. Due to this, some people believe that there is a risk in just _using_ software under GPL or AGPL
licenses (even without _modifying_ it).
For the avoidance of doubt, the owners of this software licensed under an AGPL 3.0 license wish to make a clarifying
public statement as follows:
> Please note that software derived as a result of modifying the source code of this software in order to fix a bug or
> incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e.
> links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it
> does not need to be released as under the same license, or even released as open source.