SDK reference¶
Production version - 2.0.4¶
Here is the API reference for the current production version of the SDK.
This is the recommended version for any production deployment of your certified app.
All functions below are available in:
the Evam platform (i.e. an actual Evam device) - except for the functions marked as “Preview”,
the development environment (web browser)
- Class: EvamApi
- Class: EvamAppBarContextModel
- Class: Battery
- Class: DestinationControlPointLocation
- Class: DestinationSiteLocation
- Class: HospitalLocation
- Class: Location
- Class: Notification
- Class: Operation
- Class: OperationPriority
- Class: Patient
- Class: SystemHealth
- Class: TripLocationHistory
- Class: VehicleState
- Class: VehicleStatus
- Enumeration: BatteryHealth
- Enumeration: BatteryPlugged
- Enumeration: BatteryStatus
- Enumeration: DeviceRole
- Enumeration: DisplayMode
- Enumeration: EvamEvent
- Enumeration: InternetState
- Enumeration: NotificationType
- Enumeration: default
- Module: EvamApi
- Module: component/appbar/EvamTabContext
- Module: component/appbar/utils/formatRoutePathByMenuId
- Module: dev-test-environment
- Module: dev-test-environment/components
- Module: dev-test-environment/components/NotificationComponent
- Module: dev-test-environment/components/util
- Module: dev-test-environment/components/util/VehicleServicesNoRender
- Module: dev-test-environment/context
- Module: dev-test-environment/context/VehicleServicesDevelopmentEnvironment
- Module: dev-test-environment/util/EventHelpers
- Module: dev-test-environment/util/EventHelpers/EventHelpers
- Module: domain
- Module: domain/Battery
- Module: domain/DestinationControlPointLocation
- Module: domain/DestinationSiteLocation
- Module: domain/DeviceRole
- Module: domain/DisplayMode
- Module: domain/EvamEvent
- Module: domain/HospitalLocation
- Module: domain/InternetState
- Module: domain/Location
- Module: domain/Notification
- Module: domain/NotificationType
- Module: domain/Operation
- Module: domain/OperationPriority
- Module: domain/OperationState
- Module: domain/Patient
- Module: domain/SystemHealth
- Module: domain/TripLocationHistory
- Module: domain/VehicleState
- Module: domain/VehicleStatus
- Module: domain/_InternalVehicleServicesNotification
- Module: index
- Module: util/EventHelpers
- Module: wrapper
Alpha version - 3.0.0-beta.1¶
Here is the API reference for the current alpha version of the SDK.
This is the recommended version if the production version does not yet integrate all functions you need to develop your certified app.
The functions below are currently available in the development environment only.
- Class: EvamApi
- Class: EvamHardwareUsbApi
- Class: EvamUsbManagerDev
- Class: UsbDeviceDev
- Class: EvamUsbManagerVS
- Class: UsbDeviceVS
- Class: EvamAppBarContextModel
- Class: Battery
- Class: DestinationControlPointLocation
- Class: DestinationSiteLocation
- Class: GRPC
- Class: HospitalLocation
- Class: Location
- Class: Notification
- Class: Operation
- Class: OperationPriority
- Class: Patient
- Class: SystemHealth
- Class: TripLocationHistory
- Class: VehicleState
- Class: VehicleStatus
- Enumeration: BatteryHealth
- Enumeration: BatteryPlugged
- Enumeration: BatteryStatus
- Enumeration: DeviceRole
- Enumeration: DisplayMode
- Enumeration: EvamEvent
- Enumeration: InternetState
- Enumeration: NotificationType
- Enumeration: default
- Interface: UsbDevice
- Interface: UsbDeviceFilter
- Interface: UsbEndpoint
- Interface: UsbInterface
- Interface: UsbManager
- Interface: UsbTransferResult
- Interface: AndroidInterface
- Module: EvamApi
- Module: api/hardware/EvamHardwareUsbApi
- Module: api/hardware/framework/dev/EvamUsbManagerDev
- Module: api/hardware/framework/vs/AndroidInterface
- Module: api/hardware/framework/vs/EvamUsbManagerVS
- Module: api/hardware/framework/vs/mapper/mapNativeJsonToUrbInterfaceList
- Module: api/hardware/framework/vs/mapper/mapNativeJsonToUsbDevice
- Module: component/appbar/EvamTabContext
- Module: component/appbar/utils/formatRoutePathByMenuId
- Module: dev-test-environment
- Module: dev-test-environment/components
- Module: dev-test-environment/components/NotificationComponent
- Module: dev-test-environment/components/util
- Module: dev-test-environment/components/util/VehicleServicesNoRender
- Module: dev-test-environment/context
- Module: dev-test-environment/context/VehicleServicesDevelopmentEnvironment
- Module: dev-test-environment/util/EventHelpers
- Module: dev-test-environment/util/EventHelpers/EventHelpers
- Module: domain
- Module: domain/Battery
- Module: domain/DestinationControlPointLocation
- Module: domain/DestinationSiteLocation
- Module: domain/DeviceRole
- Module: domain/DisplayMode
- Module: domain/EvamEvent
- Module: domain/GRPC
- Module: domain/HospitalLocation
- Module: domain/InternetState
- Module: domain/Location
- Module: domain/Notification
- Module: domain/NotificationType
- Module: domain/Operation
- Module: domain/OperationPriority
- Module: domain/OperationState
- Module: domain/Patient
- Module: domain/SystemHealth
- Module: domain/TripLocationHistory
- Module: domain/VehicleState
- Module: domain/VehicleStatus
- Module: domain/_InternalVehicleServicesNotification
- Module: index
- Module: util/EventHelpers
- Module: wrapper
Roadmap¶
The Evam SDK is evolving constantly to add more functions, data sharing and access to system functions.
This is how we plan on developing the SDK moving forward. If you have some input - such as a feature request - please get in touch with us via the public or private issue tracker in the developer portal!
Addition of new APIs for hardware access (CANBus, USB),
Addition of new APIs for interacting with the Navigation App (add elements in the map, etc),
Improvements to the Development environment.
Other versions¶
Those versions of the SDK are here for reference only, it is recommended you use either the Production or Alpha version instead.
2.0.1¶
- Class: EvamApi
- Class: EvamAppBarContextModel
- Class: Battery
- Class: DestinationControlPointLocation
- Class: DestinationSiteLocation
- Class: HospitalLocation
- Class: Location
- Class: Notification
- Class: Operation
- Class: OperationPriority
- Class: Patient
- Class: SystemHealth
- Class: TripLocationHistory
- Class: VehicleState
- Class: VehicleStatus
- Enumeration: BatteryHealth
- Enumeration: BatteryPlugged
- Enumeration: BatteryStatus
- Enumeration: DeviceRole
- Enumeration: DisplayMode
- Enumeration: EvamEvent
- Enumeration: InternetState
- Enumeration: NotificationType
- Enumeration: default
- Module: EvamApi
- Module: component/appbar/EvamTabContext
- Module: component/appbar/utils/formatRoutePathByMenuId
- Module: dev-test-environment
- Module: dev-test-environment/components
- Module: dev-test-environment/components/NotificationComponent
- Module: dev-test-environment/components/util
- Module: dev-test-environment/components/util/VehicleServicesNoRender
- Module: dev-test-environment/context
- Module: dev-test-environment/context/VehicleServicesDevelopmentEnvironment
- Module: dev-test-environment/util/EventHelpers
- Module: dev-test-environment/util/EventHelpers/EventHelpers
- Module: domain
- Module: domain/Battery
- Module: domain/DestinationControlPointLocation
- Module: domain/DestinationSiteLocation
- Module: domain/DeviceRole
- Module: domain/DisplayMode
- Module: domain/EvamEvent
- Module: domain/HospitalLocation
- Module: domain/InternetState
- Module: domain/Location
- Module: domain/Notification
- Module: domain/NotificationType
- Module: domain/Operation
- Module: domain/OperationPriority
- Module: domain/OperationState
- Module: domain/Patient
- Module: domain/SystemHealth
- Module: domain/TripLocationHistory
- Module: domain/VehicleState
- Module: domain/VehicleStatus
- Module: domain/_InternalVehicleServicesNotification
- Module: index
- Module: util/EventHelpers
- Module: wrapper
1.0.4¶
2.0.3¶
- Class: EvamApi
- Class: EvamAppBarContextModel
- Class: Battery
- Class: DestinationControlPointLocation
- Class: DestinationSiteLocation
- Class: HospitalLocation
- Class: Location
- Class: Notification
- Class: Operation
- Class: OperationPriority
- Class: Patient
- Class: SystemHealth
- Class: TripLocationHistory
- Class: VehicleState
- Class: VehicleStatus
- Enumeration: BatteryHealth
- Enumeration: BatteryPlugged
- Enumeration: BatteryStatus
- Enumeration: DeviceRole
- Enumeration: DisplayMode
- Enumeration: EvamEvent
- Enumeration: InternetState
- Enumeration: NotificationType
- Enumeration: default
- Module: EvamApi
- Module: component/appbar/EvamTabContext
- Module: component/appbar/utils/formatRoutePathByMenuId
- Module: dev-test-environment
- Module: dev-test-environment/components
- Module: dev-test-environment/components/NotificationComponent
- Module: dev-test-environment/components/util
- Module: dev-test-environment/components/util/VehicleServicesNoRender
- Module: dev-test-environment/context
- Module: dev-test-environment/context/VehicleServicesDevelopmentEnvironment
- Module: dev-test-environment/util/EventHelpers
- Module: dev-test-environment/util/EventHelpers/EventHelpers
- Module: domain
- Module: domain/Battery
- Module: domain/DestinationControlPointLocation
- Module: domain/DestinationSiteLocation
- Module: domain/DeviceRole
- Module: domain/DisplayMode
- Module: domain/EvamEvent
- Module: domain/HospitalLocation
- Module: domain/InternetState
- Module: domain/Location
- Module: domain/Notification
- Module: domain/NotificationType
- Module: domain/Operation
- Module: domain/OperationPriority
- Module: domain/OperationState
- Module: domain/Patient
- Module: domain/SystemHealth
- Module: domain/TripLocationHistory
- Module: domain/VehicleState
- Module: domain/VehicleStatus
- Module: domain/_InternalVehicleServicesNotification
- Module: index
- Module: util/EventHelpers
- Module: wrapper
2.0.2¶
- Class: EvamApi
- Class: EvamAppBarContextModel
- Class: Battery
- Class: DestinationControlPointLocation
- Class: DestinationSiteLocation
- Class: HospitalLocation
- Class: Location
- Class: Notification
- Class: Operation
- Class: OperationPriority
- Class: Patient
- Class: SystemHealth
- Class: TripLocationHistory
- Class: VehicleState
- Class: VehicleStatus
- Enumeration: BatteryHealth
- Enumeration: BatteryPlugged
- Enumeration: BatteryStatus
- Enumeration: DeviceRole
- Enumeration: DisplayMode
- Enumeration: EvamEvent
- Enumeration: InternetState
- Enumeration: NotificationType
- Enumeration: default
- Module: EvamApi
- Module: component/appbar/EvamTabContext
- Module: component/appbar/utils/formatRoutePathByMenuId
- Module: dev-test-environment
- Module: dev-test-environment/components
- Module: dev-test-environment/components/NotificationComponent
- Module: dev-test-environment/components/util
- Module: dev-test-environment/components/util/VehicleServicesNoRender
- Module: dev-test-environment/context
- Module: dev-test-environment/context/VehicleServicesDevelopmentEnvironment
- Module: dev-test-environment/util/EventHelpers
- Module: dev-test-environment/util/EventHelpers/EventHelpers
- Module: domain
- Module: domain/Battery
- Module: domain/DestinationControlPointLocation
- Module: domain/DestinationSiteLocation
- Module: domain/DeviceRole
- Module: domain/DisplayMode
- Module: domain/EvamEvent
- Module: domain/HospitalLocation
- Module: domain/InternetState
- Module: domain/Location
- Module: domain/Notification
- Module: domain/NotificationType
- Module: domain/Operation
- Module: domain/OperationPriority
- Module: domain/OperationState
- Module: domain/Patient
- Module: domain/SystemHealth
- Module: domain/TripLocationHistory
- Module: domain/VehicleState
- Module: domain/VehicleStatus
- Module: domain/_InternalVehicleServicesNotification
- Module: index
- Module: util/EventHelpers
- Module: wrapper
2.0.0¶
- Class: EvamApi
- Class: EvamAppBarContextModel
- Class: Battery
- Class: DestinationControlPointLocation
- Class: DestinationSiteLocation
- Class: HospitalLocation
- Class: Location
- Class: Notification
- Class: Operation
- Class: OperationPriority
- Class: Patient
- Class: SystemHealth
- Class: TripLocationHistory
- Class: VehicleState
- Class: VehicleStatus
- Enumeration: BatteryHealth
- Enumeration: BatteryPlugged
- Enumeration: BatteryStatus
- Enumeration: DeviceRole
- Enumeration: DisplayMode
- Enumeration: EvamEvent
- Enumeration: InternetState
- Enumeration: NotificationType
- Enumeration: default
- Module: EvamApi
- Module: component/appbar/EvamTabContext
- Module: component/appbar/utils/formatRoutePathByMenuId
- Module: dev-test-environment
- Module: dev-test-environment/components
- Module: dev-test-environment/components/NotificationComponent
- Module: dev-test-environment/components/util
- Module: dev-test-environment/components/util/VehicleServicesNoRender
- Module: dev-test-environment/context
- Module: dev-test-environment/context/VehicleServicesDevelopmentEnvironment
- Module: dev-test-environment/util/EventHelpers
- Module: dev-test-environment/util/EventHelpers/EventHelpers
- Module: domain
- Module: domain/Battery
- Module: domain/DestinationControlPointLocation
- Module: domain/DestinationSiteLocation
- Module: domain/DeviceRole
- Module: domain/DisplayMode
- Module: domain/EvamEvent
- Module: domain/HospitalLocation
- Module: domain/InternetState
- Module: domain/Location
- Module: domain/Notification
- Module: domain/NotificationType
- Module: domain/Operation
- Module: domain/OperationPriority
- Module: domain/OperationState
- Module: domain/Patient
- Module: domain/SystemHealth
- Module: domain/TripLocationHistory
- Module: domain/VehicleState
- Module: domain/VehicleStatus
- Module: domain/_InternalVehicleServicesNotification
- Module: index
- Module: util/EventHelpers
- Module: wrapper