smia.utilities.fipa_acl_info module

class smia.utilities.fipa_acl_info.FIPAACLInfo[source]

Bases: object

This class contains the values related to FIPA-ACL standard.

FIPA_ACL_PERFORMATIVE_ATTRIB = 'performative'
FIPA_ACL_ONTOLOGY_ATTRIB = 'ontology'
FIPA_ACL_PROTOCOL_ATTRIB = 'protocol'
FIPA_ACL_ENCODING_ATTRIB = 'encoding'
FIPA_ACL_LANGUAGE_ATTRIB = 'language'
FIPA_ACL_PERFORMATIVE_CFP = 'cfp'
FIPA_ACL_PERFORMATIVE_INFORM = 'inform'
FIPA_ACL_PERFORMATIVE_REQUEST = 'request'
FIPA_ACL_PERFORMATIVE_PROPOSE = 'propose'
FIPA_ACL_PERFORMATIVE_FAILURE = 'failure'
FIPA_ACL_PERFORMATIVE_QUERY_IF = 'query-if'
FIPA_ACL_PERFORMATIVE_QUERY_REF = 'query-ref'
FIPA_ACL_REQUEST_PROTOCOL = 'fipa-request'
FIPA_ACL_CONTRACT_NET_PROTOCOL = 'fipa-contract-net'
FIPA_ACL_QUERY_PROTOCOL = 'fipa-query'
FIPA_ACL_PERFORMATIVE_ACCEPT_PROPOSAL = 'AcceptProposal'
FIPA_ACL_PERFORMATIVE_REJECT_PROPOSAL = 'RejectProposal'
FIPA_ACL_PERFORMATIVE_AGREE = 'Agree'
FIPA_ACL_PERFORMATIVE_CONFIRM = 'Confirm'
FIPA_ACL_PERFORMATIVE_NOT_UNDERSTOOD = 'NotUnderstood'
FIPA_ACL_PERFORMATIVE_REFUSE = 'Refuse'
FIPA_ACL_ONTOLOGY_SVC_REQUEST = 'SvcRequest'
FIPA_ACL_ONTOLOGY_SVC_RESPONSE = 'SvcResponse'
FIPA_ACL_ONTOLOGY_CAPABILITY_REQUEST = 'CapabilityRequest'
FIPA_ACL_ONTOLOGY_CAPABILITY_CHECKING = 'CapabilityChecking'
FIPA_ACL_ONTOLOGY_CAPABILITY_RESPONSE = 'CapabilityResponse'
FIPA_ACL_ONTOLOGY_SVC_NEGOTIATION = 'Negotiation'
FIPA_ACL_DEFAULT_ENCODING = 'application/json'
FIPA_ACL_DEFAULT_LANGUAGE = 'smia-language'
class smia.utilities.fipa_acl_info.ACLSMIAOntologyInfo[source]

Bases: object

This class contains the values related to ACL-SMIA ontology library information: the ontology classification established for the SMIA approach.

ACL_ONTOLOGY_AAS_SERVICE = 'aas-service'
ACL_ONTOLOGY_AAS_INFRASTRUCTURE_SERVICE = 'aas-infrastructure-service'
ACL_ONTOLOGY_CSS_SERVICE = 'css-service'
class smia.utilities.fipa_acl_info.ServiceTypes[source]

Bases: object

This class contains all service types defined in the Functional View of RAMI 4.0.

AAS_INFRASTRUCTURE_SERVICE = 'AASInfrastructureService'
AAS_SERVICE = 'AASservice'
SUBMODEL_SERVICE = 'SubmodelService'
class smia.utilities.fipa_acl_info.ACLSMIAJSONSchemas[source]

Bases: object

This class contains all the JSON schemas related to ACL messages sent between SMIA agents.

JSON_SCHEMA_AAS_MODEL_REFERENCE_old = {'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}
JSON_SCHEMA_SUBMODEL_SERVICE_REQUEST = {'oneOf': [{'required': ['ModelReference']}, {'required': ['ExternalReference']}], 'properties': {'ExternalReference': {'type': 'string'}, 'ModelReference': {'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}}, 'type': 'object'}
JSON_SCHEMA_ASSET_SERVICE_REQUEST = {'properties': {'ModelReference': {'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}, 'serviceParameterValues': {'additionalProperties': {'type': 'string'}, 'type': 'object'}}, 'required': ['ModelReference'], 'type': 'object'}
JSON_SCHEMA_CAPABILITY_REQUEST = {'properties': {'capabilityName': {'type': 'string'}, 'skillInterfaceName': {'type': 'string'}, 'skillName': {'type': 'string'}, 'skillParameterValues': {'additionalProperties': {'type': 'string'}, 'type': 'object'}}, 'required': ['capabilityName'], 'type': 'object'}
AAS_MODEL_REFERENCE_STRING_PATTERN = '^(\\[[^\\[\\],]+,[^\\[\\],]+\\])+$'
JSON_SCHEMA_AAS_MODEL_REFERENCE = {'oneOf': [{'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}, {'description': 'ModelReference format for strings: [type,value][type,value]...', 'pattern': '^(\\[[^\\[\\],]+,[^\\[\\],]+\\])+$', 'type': 'string'}]}
JSON_SCHEMA_SMIA_INSTANCE_INFORMATION = {'properties': {'aasID': {'type': 'string'}, 'asset': {'properties': {'id': {'type': 'string'}, 'kind': {'type': 'string'}, 'type': {'type': 'string'}}, 'type': 'object'}, 'id': {'type': 'string'}, 'smiaVersion': {'type': 'string'}, 'startedTimeStamp': {'type': 'integer'}, 'status': {'type': 'string'}}, 'required': ['id', 'asset', 'aasID'], 'type': 'object'}
JSON_SCHEMA_AAS_SERVICE = {'allOf': [{'if': {'properties': {'serviceID': {'const': 'GetSubmodelElementByReference'}}}, 'then': {'properties': {'serviceParams': {'oneOf': [{'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}, {'description': 'ModelReference format for strings: [type,value][type,value]...', 'pattern': '^(\\[[^\\[\\],]+,[^\\[\\],]+\\])+$', 'type': 'string'}]}}}}, {'if': {'properties': {'serviceID': {'enum': ['GetAASInformationByAssetID']}}}, 'then': {'properties': {'serviceParams': {'type': 'string'}}}}], 'properties': {'serviceID': {'type': 'string'}, 'serviceParams': {}, 'serviceType': {'enum': ['SubmodelRegistryService', 'MetaInformationManagementService', 'DiscoveryService'], 'type': 'string'}}, 'required': ['serviceID', 'serviceType'], 'title': 'AASServiceSchema', 'type': 'object'}
JSON_SCHEMA_AAS_INFRASTRUCTURE_SERVICE = {'allOf': [{'if': {'properties': {'serviceID': {'const': 'RegistrySMIAInstance'}}}, 'then': {'properties': {'serviceParams': {'properties': {'aasID': {'type': 'string'}, 'asset': {'properties': {'id': {'type': 'string'}, 'kind': {'type': 'string'}, 'type': {'type': 'string'}}, 'type': 'object'}, 'id': {'type': 'string'}, 'smiaVersion': {'type': 'string'}, 'startedTimeStamp': {'type': 'integer'}, 'status': {'type': 'string'}}, 'required': ['id', 'asset', 'aasID'], 'type': 'object'}}}}, {'if': {'properties': {'serviceID': {'enum': ['GetSMIAInstanceIDByAssetID', 'GetAssetIDBySMIAInstanceID', 'GetAllAssetIDByCapability']}}}, 'then': {'properties': {'serviceParams': {'type': 'string'}}}}], 'properties': {'serviceID': {'type': 'string'}, 'serviceParams': {}, 'serviceType': {'enum': ['RegistryService', 'DiscoveryService'], 'type': 'string'}}, 'required': ['serviceID', 'serviceType'], 'title': 'AASInfrastructureServiceSchema', 'type': 'object'}
JSON_SCHEMA_CSS_SERVICE = {'properties': {'capabilityIRI': {'type': 'string'}, 'constraints': {'additionalProperties': {'type': 'string'}, 'type': 'object'}, 'negCriterion': {'type': 'string'}, 'negRequester': {'type': 'string'}, 'negTargets': {'items': {'type': 'string'}, 'type': 'array'}, 'negValue': {'maximum': 1.0, 'minimum': 0.0, 'type': 'number'}, 'skillIRI': {'type': 'string'}, 'skillInterfaceIRI': {'type': 'string'}, 'skillParams': {'additionalProperties': {'type': 'string'}, 'type': 'object'}}, 'required': ['capabilityIRI'], 'type': 'object'}
JSON_SCHEMA_ACL_SMIA_ONTOLOGIES_MAP = {'aas-infrastructure-service': {'allOf': [{'if': {'properties': {'serviceID': {'const': 'RegistrySMIAInstance'}}}, 'then': {'properties': {'serviceParams': {'properties': {'aasID': {'type': 'string'}, 'asset': {'properties': {'id': {'type': 'string'}, 'kind': {'type': 'string'}, 'type': {'type': 'string'}}, 'type': 'object'}, 'id': {'type': 'string'}, 'smiaVersion': {'type': 'string'}, 'startedTimeStamp': {'type': 'integer'}, 'status': {'type': 'string'}}, 'required': ['id', 'asset', 'aasID'], 'type': 'object'}}}}, {'if': {'properties': {'serviceID': {'enum': ['GetSMIAInstanceIDByAssetID', 'GetAssetIDBySMIAInstanceID', 'GetAllAssetIDByCapability']}}}, 'then': {'properties': {'serviceParams': {'type': 'string'}}}}], 'properties': {'serviceID': {'type': 'string'}, 'serviceParams': {}, 'serviceType': {'enum': ['RegistryService', 'DiscoveryService'], 'type': 'string'}}, 'required': ['serviceID', 'serviceType'], 'title': 'AASInfrastructureServiceSchema', 'type': 'object'}, 'aas-service': {'allOf': [{'if': {'properties': {'serviceID': {'const': 'GetSubmodelElementByReference'}}}, 'then': {'properties': {'serviceParams': {'oneOf': [{'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}, {'description': 'ModelReference format for strings: [type,value][type,value]...', 'pattern': '^(\\[[^\\[\\],]+,[^\\[\\],]+\\])+$', 'type': 'string'}]}}}}, {'if': {'properties': {'serviceID': {'enum': ['GetAASInformationByAssetID']}}}, 'then': {'properties': {'serviceParams': {'type': 'string'}}}}], 'properties': {'serviceID': {'type': 'string'}, 'serviceParams': {}, 'serviceType': {'enum': ['SubmodelRegistryService', 'MetaInformationManagementService', 'DiscoveryService'], 'type': 'string'}}, 'required': ['serviceID', 'serviceType'], 'title': 'AASServiceSchema', 'type': 'object'}, 'agent-related-service': {'properties': {'serviceParams': {'additionalProperties': {'type': 'string'}, 'type': 'object'}, 'serviceRef': {'oneOf': [{'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}, {'description': 'ModelReference format for strings: [type,value][type,value]...', 'pattern': '^(\\[[^\\[\\],]+,[^\\[\\],]+\\])+$', 'type': 'string'}]}}, 'required': ['serviceRef'], 'title': 'AssetAgentRelatedServiceSchema', 'type': 'object'}, 'asset-related-service': {'properties': {'serviceParams': {'additionalProperties': {'type': 'string'}, 'type': 'object'}, 'serviceRef': {'oneOf': [{'properties': {'keys': {'items': {'properties': {'type': {'type': 'string'}, 'value': {'type': 'string'}}, 'required': ['type', 'value'], 'type': 'object'}, 'type': 'array'}}, 'required': ['keys'], 'type': 'object'}, {'description': 'ModelReference format for strings: [type,value][type,value]...', 'pattern': '^(\\[[^\\[\\],]+,[^\\[\\],]+\\])+$', 'type': 'string'}]}}, 'required': ['serviceRef'], 'title': 'AssetAgentRelatedServiceSchema', 'type': 'object'}, 'css-service': {'properties': {'capabilityIRI': {'type': 'string'}, 'constraints': {'additionalProperties': {'type': 'string'}, 'type': 'object'}, 'negCriterion': {'type': 'string'}, 'negRequester': {'type': 'string'}, 'negTargets': {'items': {'type': 'string'}, 'type': 'array'}, 'negValue': {'maximum': 1.0, 'minimum': 0.0, 'type': 'number'}, 'skillIRI': {'type': 'string'}, 'skillInterfaceIRI': {'type': 'string'}, 'skillParams': {'additionalProperties': {'type': 'string'}, 'type': 'object'}}, 'required': ['capabilityIRI'], 'type': 'object'}}