Documentation
¶
Overview ¶
Package mapmodel provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.5.1 DO NOT EDIT.
Code generated by tools/generate from schema x-known-values; DO NOT EDIT.
Index ¶
Constants ¶
const ( MapAreaKindCurrent MapAreaKind = "current" MapAreaKindErase MapAreaKind = "erase" MapAreaKindNoCarpet MapAreaKind = "no-carpet" MapAreaKindNoGo MapAreaKind = "no-go" MapAreaKindNoMop MapAreaKind = "no-mop" MapAreaKindUnknown MapAreaKind = "unknown" MapAreaKindWall MapAreaKind = "wall" MapPathKindClean MapPathKind = "clean" MapPathKindGoto MapPathKind = "goto" MapPathKindPredicted MapPathKind = "predicted" MapPathKindTrace MapPathKind = "trace" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MapArea ¶
type MapArea struct {
// Frame Q10 trace is dock-relative; Q10 array is absolute raster coordinates; these frames must not be combined without explicit calibration.
Frame MapFrame `json:"frame"`
// Kind Open area kind. Known values describe current cleaning zones, walls, no-go, no-mop, no-carpet, erase areas, or unknown semantics; future kinds remain representable.
Kind MapAreaKind `json:"kind"`
Points []MapPoint `json:"points"`
SourceIndex *int64 `json:"sourceIndex,omitempty"`
SourceStatus *int64 `json:"sourceStatus,omitempty"`
// SourceType Uninterpreted source area type when present.
SourceType *int64 `json:"sourceType,omitempty"`
Unit MapUnit `json:"unit"`
}
MapArea defines model for MapArea.
type MapAreaKind ¶
type MapAreaKind = string
MapAreaKind Open area kind. Known values describe current cleaning zones, walls, no-go, no-mop, no-carpet, erase areas, or unknown semantics; future kinds remain representable.
type MapFrame ¶
type MapFrame string
MapFrame Q10 trace is dock-relative; Q10 array is absolute raster coordinates; these frames must not be combined without explicit calibration.
type MapGrid ¶
type MapGrid struct {
// Cells Row-major source occupancy bytes; cell semantics depend on format.
Cells []byte `json:"cells"`
// Frame Q10 trace is dock-relative; Q10 array is absolute raster coordinates; these frames must not be combined without explicit calibration.
Frame MapFrame `json:"frame"`
// Height Number of rows.
Height int `json:"height"`
Origin *MapPoint `json:"origin,omitempty"`
// Resolution Source world units per cell; absent when calibration is unavailable.
Resolution *float64 `json:"resolution,omitempty"`
// RoomCells Optional source room-assignment raster.
RoomCells *[]byte `json:"roomCells,omitempty"`
// RowYDirection Sign of source-world Y change as the stored raster row increases.
RowYDirection MapGridRowYDirection `json:"rowYDirection"`
// TopDown True when row zero corresponds to the top of the displayed raster.
TopDown bool `json:"topDown"`
Unit MapUnit `json:"unit"`
// Width Number of columns.
Width int `json:"width"`
}
MapGrid defines model for MapGrid.
type MapGridRowYDirection ¶
type MapGridRowYDirection int
MapGridRowYDirection Sign of source-world Y change as the stored raster row increases.
const ( Minus1 MapGridRowYDirection = -1 N1 MapGridRowYDirection = 1 )
Defines values for MapGridRowYDirection.
type MapPath ¶
type MapPath struct {
// Frame Q10 trace is dock-relative; Q10 array is absolute raster coordinates; these frames must not be combined without explicit calibration.
Frame MapFrame `json:"frame"`
// Kind Open path kind. Known values are clean, goto, predicted, and trace; future source kinds remain representable.
Kind MapPathKind `json:"kind"`
Points []MapPoint `json:"points"`
Unit MapUnit `json:"unit"`
}
MapPath defines model for MapPath.
type MapPathKind ¶
type MapPathKind = string
MapPathKind Open path kind. Known values are clean, goto, predicted, and trace; future source kinds remain representable.
type MapPoint ¶
type MapPoint struct {
// X Horizontal coordinate in the containing geometry unit and frame.
X float64 `json:"x"`
// Y Vertical coordinate in the containing geometry unit and frame.
Y float64 `json:"y"`
}
MapPoint defines model for MapPoint.
type MapPose ¶
type MapPose struct {
// Frame Q10 trace is dock-relative; Q10 array is absolute raster coordinates; these frames must not be combined without explicit calibration.
Frame MapFrame `json:"frame"`
// Heading Source heading; headingUnit identifies degrees or radians.
Heading *float64 `json:"heading,omitempty"`
HeadingUnit *MapPoseHeadingUnit `json:"headingUnit,omitempty"`
Point MapPoint `json:"point"`
Unit MapUnit `json:"unit"`
}
MapPose defines model for MapPose.
type MapPoseHeadingUnit ¶
type MapPoseHeadingUnit string
MapPoseHeadingUnit defines model for MapPose.HeadingUnit.
const ( Degrees MapPoseHeadingUnit = "degrees" Radians MapPoseHeadingUnit = "radians" )
Defines values for MapPoseHeadingUnit.
type MapRectangle ¶
MapRectangle defines model for MapRectangle.
type MapRoom ¶
type MapRoom struct {
Bounds *MapRectangle `json:"bounds,omitempty"`
CleanState *int64 `json:"cleanState,omitempty"`
// Frame Q10 trace is dock-relative; Q10 array is absolute raster coordinates; these frames must not be combined without explicit calibration.
Frame MapFrame `json:"frame"`
// Id Source room identifier; absent remains absent.
Id *int64 `json:"id,omitempty"`
Label *MapPoint `json:"label,omitempty"`
Material *int64 `json:"material,omitempty"`
Name *string `json:"name,omitempty"`
Outline *[]MapPoint `json:"outline,omitempty"`
RoomType *int64 `json:"roomType,omitempty"`
Unit MapUnit `json:"unit"`
}
MapRoom defines model for MapRoom.
type MapSnapshot ¶
type MapSnapshot struct {
CurrentZones []MapArea `json:"currentZones"`
Dock *MapPose `json:"dock,omitempty"`
Format MapFormat `json:"format"`
// FormatId Source map-type or packet-kind identifier; never inferred when absent.
FormatId *int64 `json:"formatId,omitempty"`
Grid *MapGrid `json:"grid,omitempty"`
MapId *int64 `json:"mapId,omitempty"`
Paths []MapPath `json:"paths"`
Restrictions []MapArea `json:"restrictions"`
Robot *MapPose `json:"robot,omitempty"`
Rooms []MapRoom `json:"rooms"`
UnknownBlocks []MapUnknownBlock `json:"unknownBlocks"`
Walls []MapArea `json:"walls"`
}
MapSnapshot defines model for MapSnapshot.