spade-fiware-artifacts 0.1.1

A toolkit for multi-agent systems to interact with FIWARE's context management system

Documentation

Check out the documentation at: https://spade-fiware-artifacts.readthedocs.io

Overview

SPADE-FIWARE-Artifacts is a Python library that bridges SPADE (Smart Python Agent Development Environment) with FIWARE Context Brokers. It provides a toolkit for multi-agent systems to interact with FIWARE’s context management system, supporting both Orion and Scorpio Context Brokers through NGSI-LD.

Key Features

• NGSI-LD Support: Full compatibility with FIWARE’s NGSI-LD API

• Asynchronous Operations: Built on asyncio for efficient non-blocking operations

• Flexible Data Processing: Customizable data transformation and handling

• Configurable JSON Templates: Allows customized JSON templates for data structuring and flexible formatting.

Core Components

InserterArtifact

A component for managing entity data in FIWARE Context Brokers:

• Entity Management: - Create new entities with complex attributes - Update existing entities (full or partial updates) - Handle different attribute types (Properties, GeoProperties, Relationships)

Example usage:

inserter = InserterArtifact(
    jid="[e-mail]",
    passwd="password",
    publisher_jid="[e-mail]",
    host="broker.example.com",
    project_name="my_project"
)

SubscriptionManagerArtifact

Manages subscriptions and handles notifications from the Context Broker:

• Subscription Features: - Create and manage NGSI-LD subscriptions - Monitor specific entity attributes under specific conditions - Handle subscription lifecycle (create, update, delete)

Example usage:

subscription_manager = SubscriptionManagerArtifact(
    jid="[e-mail]",
    passwd="password",
    config=config_payload,
    broker_url="http://broker.example.com:9090"
)

where:

config_payload = {
    "entity_type": "WasteContainer",
    "entity_id": "088",
    "watched_attributes": [],
    "q_filter": "fillingLevel>0.7",
    "context": [
        "https://raw.githubusercontent.com/smart-data-models/dataModel.WasteManagement/master/context.jsonld"
    ],
    "delete_all_artefact_subscriptions": true,
    "delete_subscription_identifier": "subs_1",
    "subscription_identifier": "subs_2",
    "delete_only": false
}

Installation

Install via pip:

pip install spade-fiware-artifacts

Quick Start

1. Configure Your Environment

   Create a config.json file:

   {
       "XMPP_SERVER": "your.xmpp.server",
       "subscriber_artifact_name": "art_subscriber",
       "broker_port": "http://localhost:9090"
   }

2. Initialize Artifacts

   from spade_fiware_artifacts import InserterArtifact, SubscriptionManagerArtifact
   
   inserter = InserterArtifact(
       jid="[e-mail]",
       passwd="password",
       publisher_jid="[e-mail]",
       host="localhost",
       project_name="test_project"
   )