README.md

robotframework-c8y

Robot Framework Library for Cumulocity IoT

Using it

1. Install via pip

   pip install git+https://github.com/reubenmiller/[email protected]

   Or add it to your requirements.txt file

   robotframework-c8y @ git+https://github.com/reubenmiller/[email protected]

   Then install it via

   pip install -r requirements.txt

2. Create a .env file with the following environment variables

   C8Y_BASEURL=https://example.tenant.c8y.com
   C8Y_USER=
   C8Y_TENANT=t12345
   C8Y_PASSWORD=""

3. Create a Robot test tests/Example.robot

   *** Settings ***
   Library    Cumulocity
   
   *** Test Cases ***
   Device initialization sequence
       Device Should Exist                      tedge01
       Device Should Have Installed Software    tedge
       Device Should Have Measurements          minimum=1   type=myCustomMeasurement

4. Run the test

   robot tests/Example.robot

Library docs

Checkout the Cumulocity Library docs

You can generate the docs yourself using:

libdoc Cumulocity/Cumulocity.py show > Cumulocity/Cumulocity.rst

Or the more interactive html documentation using:

libdoc Cumulocity/Cumulocity.py Cumulocity/Cumulocity.html