Using Olympe enums types

In addition to the ARSDK messages, Olympe also provides Python Enum and Bitfield types in the olympe.enums.<feature_name>[.<class_name>] modules.

Most of the time, you shouldn’t really need to import an enum type into your script because enum types are implicitly constructed from a string when you create a message object, so the following examples are roughly equivalent:

import olympe
import os
from olympe.messages.ardrone3.PilotingState import FlyingStateChanged
from olympe.enums.ardrone3.PilotingState import FlyingStateChanged_State as FlyingState

olympe.log.update_config({"loggers": {"olympe": {"level": "WARNING"}}})

DRONE_IP = os.environ.get("DRONE_IP", "10.202.0.1")


def test_enums():
    drone = olympe.Drone(DRONE_IP)
    drone.connect()
    assert drone(FlyingStateChanged(state="landed")).wait(5).success()
    # is equivalent to
    assert drone(FlyingStateChanged(state=FlyingState.landed)).wait(5).success()
    drone.disconnect()


if __name__ == "__main__":
    test_enums()

Olympe enum types should behave very much like Python 3 enum.Enum.

Bitfields types are associated to each ARSDK enums types and are occasionally used by ARSDK messages. A Bitfield type can hold any combination of its associated Enum type values.

Bitfield example:

import olympe
import os
from olympe.messages.ardrone3.PilotingState import FlyingStateChanged
from olympe.enums.ardrone3.PilotingState import FlyingStateChanged_State as FlyingState

olympe.log.update_config({"loggers": {"olympe": {"level": "WARNING"}}})

DRONE_IP = os.environ.get("DRONE_IP", "10.202.0.1")


def test_bitfield():
    drone = olympe.Drone(DRONE_IP)
    drone.connect()

    flying_states = FlyingState._bitfield_type_("takingoff|hovering|flying")

    if drone.get_state(FlyingStateChanged)["state"] in flying_states:
        assert False, "The drone should not be flying"
    else:
        print("The drone is not in flight")
    drone.disconnect()


if __name__ == "__main__":
    test_bitfield()

Additional usage examples are available in the unit tests of olympe.arsdkng.enums.