System

This section contains a API calls to enable/disable parts of Misty's system.

EnableCameraService

Enables the camera service running on Misty's 820 processor.

misty.enable_camera_service()

For more information about disabling and enabling the camera service, see the DisableCameraService command description.

DisableCameraService

Disables the camera service running on Misty's 820 processor.

Disabling a specific service frees up memory on the 820 processor for other tasks, and can improve the performance of other services that use the same processor. As an example, you may consider disabling the audio and camera services before you start mapping or tracking within a map to improve the performance of Misty's simultaneous localization and mapping (SLAM) activities.

misty.disable_camera_service()

CameraServiceEnabled

Describes whether the camera service running on Misty's 820 processor is currently enabled.

misty.camera_service_enabled()

EnableAudioService

Enables the audio service running on Misty's 820 processor.

misty.enable_audio_service()

DisableAudioService

Disables Misty's audio service.

misty.disable_audio_service()

EnableAVStreamingService

Enables Misty's AV streaming service for other API calls in Stream Assets

misty.enable_av_streaming_service()

DisableAVStreamingService

Disables Misty's AV streaming service.

misty.disable_av_streaming_service()

EnableSlamService (Misty II Pro)

Enables the SLAM service running on Misty's 820 processor.

misty.enable_slam_service()

For more information about disabling and enabling the SLAM service, see the DisableSlamService command description.

DisableSlamService

Disables Misty's Slam service.

misty.disable_slam_service()

GetAvailableWiFiNetworks

Obtains a list of local Wi-Fi networks and basic information regarding each.

misty.get_available_wifi_networks

ConnectWiFi

Connects Misty to a new WiFi.

Example Code

misty.connect_to_saved_wifi("dlink-5256","home1234")

Parameters

misty.connect_wi_fi(self, networkName : str = None, password : str = None)

  • NetworkId (string) - The name of the network to connect to.

  • Password (string) - The password for the network.

ConnectToSavedWiFi

Connects Misty to a saved Wi-Fi network.

misty.connect_to_saved_wifi("tp-link1234")

Parameters

misty.connect_to_saved_wifi(self, networkId : int = None)

  • NetworkId (string) - The name of the network to connect to.

ForgetWiFi

Deletes information about a Wi-Fi network from Misty's list of saved networks. If you send this command without any parameters, Misty deletes information for all of her saved networks.

Example Code

misty.connect_to_save_wifi("tp-link1234")

Parameters

misty.forget_wifi(self, networkId : int = None)

  • NetworkId (string) - The name of the network to connect to.

StartWifiHotspot

Starts Misty II broadcasting its own wireless network.

This command lets you use Misty II as a soft access point, which is useful in environments with no local networks, or networks that Misty can't connect to (such as captive networks).

misty.start_wifi_hotspot

Follow these steps to use Misty as a WiFi hotspot:

  1. Boot up the robot.

  2. Issue a StartWifiHotspot command.

  3. Issue a GetDeviceInformation command to access the network ID and password for Misty's access point. In the GetDeviceInformation response data, the network ID is stored in the currentProfileName field, and the password is stored in the currentPreSharedKey field. Use these credentials to connect your computer or another WiFi enabled device to Misty's access point.

  4. Use Misty's standard IP address - 192.168.43.1 - to connect to the robot and issue commands from your connected device.

  5. When you are finished using Misty as an access point, issue a StopWifiHotspot command.

Tip: If you plan to use Misty as a hotspot in an environment where you are unable to connect to any wireless networks, you may consider writing a JavaScript or .NET skill that runs on startup to issue the commands that create the access point. You can code Misty to display the credentials for the access point on her screen, or even to speak them out loud. Otherwise you must find a way to issue the HTTP API commands to start broadcasting WiFi over a separate network connection.

StopWifiHotspot

Stops Misty II broadcasting its own wireless network.

misty.stop_wifi_hotspot

To enable Misty as a soft access point, follow the steps in the documentation for the StartWifiHotspot command.

GetLogFile

Obtains log file data.

misty.get_log_file(2024/1/1)

If no date is specified, pulls up to 3MB of the most recent log data from log files up to 14 days old. Log data returns in ascending order by date and time. If all log data exceeds 3MB, the oldest entry returned may be truncated.

If a date is specified, pulls up to 3MB of log data from that date. If log data from that date exceeds 3MB, the oldest entry may be truncated.

Parameters

misty.get_log_file(self, date : datetime = None)

  • Date (string) - Optional. The date of the log file to obtain. Dates must be formatted as: MonthName/Date/FourDigitYear or FourDigitYear/MonthNumber/Date.

Last updated