Merge branch 'main' of https://github.com/gabrielpreviato/Colosseum.jl

Author: gabrielpreviato

Project.toml

@@ -4,6 +4,8 @@ authors = ["Gabriel Previato <gabriel.previato@gmail.com> and contributors"]
 version = "0.1.0"
 
 [deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MsgPack = "99f44e22-a591-53d1-9472-aa23ef4bd671"
 Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"

README.md

@@ -1,6 +1,19 @@
-# Colosseum
+# Colosseum.jl
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.previato.tech/Colosseum.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.previato.tech/Colosseum.jl/dev/)
 [![Build Status](https://github.com/gabrielpreviato/Colosseum.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/gabrielpreviato/Colosseum.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/gabrielpreviato/Colosseum.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/gabrielpreviato/Colosseum.jl)
+
+This package provides a Julia API to connect and control a Colosseum (former AirSim) simulation.
+
+Please, refer to the [Colosseum](https://github.com/CodexLabsLLC/Colosseum) repository for more informations about the project and how to build the Unreal Engine/Unity environments.
+
+## WIP
+
+Currently this package is in pre-release, the following tasks need to be done:
+
+- [ ] Add missing client functions
+- [ ] Add tests for functions and types
+- [ ] Add type enforcers in client function definitions
+- [ ] Fix current docstrings and add the missing ones

docs/src/api/api_reference.md

@@ -4,11 +4,6 @@ CurrentModule = Colosseum
 
 # Colosseum API Reference
 
-Documentation for [Colosseum](https://github.com/gabrielpreviato/Colosseum.jl).
-
-```@index
-```
-
 ```@autodocs
 Modules = [Colosseum]
 Pages = ["client.jl"]

docs/src/index.md

@@ -8,7 +8,3 @@ Documentation for [Colosseum](https://github.com/gabrielpreviato/Colosseum.jl).
 
 ```@index
 ```
-
-```@autodocs
-Modules = [Colosseum]
-```

src/Colosseum.jl

@@ -1,6 +1,23 @@
 module Colosseum
 
 include("types.jl")
+
+
+
 include("client.jl")
 
+export call, reset, getClientVersion, getServerVersion, getMinRequiredServerVersion, getMinRequiredClientVersion,
+    enableApiControl, isApiControlEnabled, armDisarm, simPause, simIsPause, simContinueForTime, simContinueForFrames,
+    getHomeGeoPoint, confirmConnection, simSetLightIntensity, simSwapTextures, simSetObjectMaterial,
+    simSetObjectMaterialFromTexture, simSetTimeOfDay, simEnableWeather, simSetWeatherParameter, simGetImage, simGetImages,
+    simGetPresetLensSettings, simGetLensSettings, simSetPresetLensSettings, simGetPresetFilmbackSettings,
+    simSetPresetFilmbackSettings, simGetFilmbackSettings, simSetFilmbackSettings, simGetFocalLength, simSetFocalLength,
+    simEnableManualFocus, simGetFocusDistance, simSetFocusDistance, simGetFocusAperture, simSetFocusAperture, simEnableFocusPlane,
+    simGetCurrentFieldOfView, simTestLineOfSightToPoint, simTestLineOfSightBetweenPoints, simGetWorldExtents, simRunConsoleCommand,
+    simGetMeshPositionVertexBuffers, simGetCollisionInfo, simSetVehiclePose, simGetVehiclePose, simSetTraceLine, simGetObjectPose,
+    simSetObjectPose, simGetObjectScale, simSetObjectScale, simListSceneObjects, simLoadLevel, simListAssets,
+    simSpawnObject, simDestroyObject, simSetSegmentationObjectID, simGetSegmentationObjectID, simAddDetectionFilterMeshName,
+    simSetDetectionFilterRadius, simClearDetectionMeshNames, simGetDetections, simPrintLogMessage, simGetCameraInfo,
+    simGetDistortionParams, simSetDistortionParams, simSetDistortionParam, simSetCameraPose, simSetCameraFov
+
 end