Skip to main content

Parameters

Definiton​

API Payload​

Class​

class Parameter:
    '''
    A class used to represent a blueprint parameter in Altergo
    ...
    
    Attributes
    ----------
    id : str
        The unique identifier of the parameter
    name : str
        The name of the parameter
    si_unit : SiUnit
        The SI unit of the parameter
    created_by : str
        The unique identifier of the user who created the parameter
    company : Company
        The unique identifier of the company that owns the parameter
    created_at : datetime
        The date and time when the parameter was created
    updated_at : datetime
        The date and time when the parameter was last updated
    '''
    
    id: Optional[str] = None
    name: Optional[str] = None
    si_unit: Optional[SiUnit] = None
    created_by: Optional[str] = None
    company: Optional[Company] = None
    created_at: Optional[datetime] = None
    updated_at: Optional[datetime] = None

Setup​

#Altergo parameters to connect with Client
ALTERGO_FACTORY_API= 'https://altergo.io/' #Default Factory API
ALTERGO_IOT_API= 'https://iot.altergo.io/' #Default IOT API
apiKey = "Your API KEY" #API key of the client

model_name='KB Demo' #Blueprint from which assset is made
serial_number='KB Demo_1'#Unique serial number to identify asset
info

API keys are user bound

from altergo_sdk.models.v2 import Parameter,siUnit
altergoApiKey = apiKey
_client = {
    "apiKey": altergoApiKey,
    "factory_api": ALTERGO_FACTORY_API,
    "iot_api":ALTERGO_IOT_API
}
altergoApi = Client(**_client)

Create​

To create a parameter you will need a corresponding SiUnit the following snippet includes the creation of the SI Unit, but you can choose to get any existing SI Unit

si_unit_of_temperature = '°C' # Symbol you want to be displayed for the unit
newSiUnitTemperature = SiUnit()
newSiUnitTemperature.name = si_unit_of_temperature

createdSiUnitTemperature = altergoApi.createSiUnit(
    newSiUnit=newSiUnitTemperature
)

temperatureSiUnit = altergoApi.getSiUnits(filterBy = {"name":"°C"})

temperatureParameterToCreate = Parameter()
temperatureParameterToCreate.name = "Temperature"
temperatureParameterToCreate.unit = temperatureSiUnit
response = altergoApi.createParameter(newParameter = temperatureParameterToCreate)

Get​

To get a SIUnit you can use the getParameters() method with a filterBy argument. In the following snippet we are retrieving the previously created Parameter.

retrievedParameter = getparameters(filterBy={"name": "Temperature"})
caution

This method returns a list

Update​

To update an SiUnit you will first need to get it via the getParameters() method and then update it with updateParameter()

retrievedParameters = getParameters(filterBy={"name": "Temperature"})
parameterToUpdate = retrievedParameters[0]
parameterToUpdate.name = "Temp"
response = updateParameter(updatedParameter = parameterToUpdate)

Delete​

To delete a SiUnit you will first need to get it via the getParameters() method and then delete it with deleteParameter()

parameterToDelete = getParameters(filterBy={"name": "Temp"})
response = deleteParameter(existingParameter = parameterToDelete)