DeviceHive Python Device Simulator

Device activity simulating tool.

Pre-requirements

To run this tool locally you need to install python dependencies by pip:

pip install -r requirements.txt

Configuration

Each argument can be passed to script in three different ways:

• Specified as command line argument (priority 0)
• Specified as environment variable (priority 1)
• Specified in config file (priority 2)

Note: If argument specified in more than one place it will be used according to priority.

Available arguments

• devices Number of devices to simulate. Default is 1.
• url (required) DeviceHive server url in format http://server.name/api/rest or ws://server.name/api/websocket.
• delay Delay between messages in seconds. Default is 1.
• base_device_name Base device name. Default is "python-test-".
• cleanup Delete devices after stop.
• verbose Show debug information.
• access_token (required) DeviceHive access token.
• refresh_token (required) DeviceHive refresh token.
• message_limit Number of messages to be sent before stop. Default is 0 (infinite loop).
• time_limit Number of seconds to work before stop. Default is 0 (infinite loop).
• message_type Type of message to be send. Can be either "notification" or "command". Default is "notification".
• message_name Message name. Default is "python-test".
• message_payload JSON-like message payload. Default is {"key": "value"}.

Note: Only access_token or refresh_token can be passed at the same time. Not both.

Command line arguments

You can pass command line arguments in format --arg_name=arg_value e.g. --devices=5 More info about CLI available in help

python run.py --help

Environment variables

Corresponding environment variables have DHDS_ prefix and can be set in format DHDS_ARG_NAME=arg_value e.g. DHDS_DEVICES=5

Config file

Config file uses JSON syntax. Path to config file can be specified by command line argument --config or by environment variable DHDS_CONFIG

Here you can found simple config example.

Payload template

Next variables can be rendered to message payload to provide more entropy.

• timestamp Current system timestamp.
• random Random float number from 0 to 1.
• randint Random int number from 0 to 4294967295.
• randbit Random int number from 0 to 1.

Variables can be used in format "$var_name" e.g.

"message_payload": {
  "timestamp": "$timestamp",
  "state": {
    "0": "$randbit",
    "1": "$randbit",
    "2": "$randbit",
    "3": "$randbit",
    "4": "$randbit"
  },
  "tick": "$randint"
}

Will be rendered to

"message_payload": {
  "timestamp": 1518784534.793083,
  "state":{
    "0": 1,
    "1": 0,
    "2": 1,
    "3": 1,
    "4": 0
  },
  "tick": 4234282600
}

Usage

This tool can be run using python 2.7+ But i strongly recommend to use python 3.5+ for better performance.

To start simulation locally run:

python run.py --url="SERVER_URL" --access_token="ACCESS_TOKEN"

To start simulation in docker run:

docker-compose up