Interface Map

Map

Describe a map with its infos, images, and map elements 🗺

See

RoboccDocs for further information

Hierarchy

  • Map

Properties

autopilots? behaviour? charging_stations? critical_battery_threshold? custom_areas? description docked_poses? fiducials? forbidden_areas? height id? id_site? img_erase_layer? img_final? img_original? img_trinary? last_update? name operational_battery_threshold? orientation_angle? resolution? routes? saved_poses? surface? threshold_high? threshold_low? uuid? uuid_preferred_charging_station? width

Properties

Optional autopilots

autopilots?: AutopilotConfig[]

List of autopilot configurations

Optional behaviour

behaviour?: Behaviour

General behaviour

Optional charging_stations

charging_stations?: ChargingStation[]

List of charging stations

Optional critical_battery_threshold

critical_battery_threshold?: number

Critical battery threshold

Optional custom_areas

custom_areas?: CustomArea[]

List of custom areas

description

description: string

Description

Optional docked_poses

docked_poses?: DockedPose[]

List of docked poses

Optional fiducials

fiducials?: Fiducial[]

List of fiducials

Optional forbidden_areas

forbidden_areas?: ForbiddenArea[]

List of forbidden areas

height

height: number

Map's height in pixel

Optional id

id?: number

Id

Optional id_site

id_site?: number

Id of parent site

Optional img_erase_layer

img_erase_layer?: string

Erase layer image in base 64

Optional img_final

img_final?: string

Final image in base 64

Optional img_original

img_original?: string

Original image in base 64

Optional img_trinary

img_trinary?: string

Trinary image in base 64

Optional last_update

last_update?: number

Timestamp of map's last update

name

name: string

Name

Optional operational_battery_threshold

operational_battery_threshold?: number

Operational battery threshold

Optional orientation_angle

orientation_angle?: number

Map's orientation angle in trigonometric direction, reverse clockwise

Optional resolution

resolution?: number

Map's resolution in cm/pixel

Optional routes

routes?: RoutesGraph

Routes graph

Optional saved_poses

saved_poses?: SavedPose[]

List of saved poses

Optional surface

surface?: number

Mapped surface of the map

Optional threshold_high

threshold_high?: number

Threshold high

Optional threshold_low

threshold_low?: number

Threshold low

Optional uuid

uuid?: number

Uuid, unique identifier on the current site

Optional uuid_preferred_charging_station

uuid_preferred_charging_station?: number

Uuid of preferred charging station

width

width: number

Map's width in pixel

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc