Interface PolarBleLowLevelApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Constructor Detail

    • Method Detail

      • readFile

         abstract ByteArray readFile(String identifier, String filePath)

        Read any file over PFtp BLE client. API user must know the exact path to the desired file. API user must also take care of parsing the returned ByteArray payload to the desired data object. NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API.

        Parameters:
        identifier - Polar device ID or BT address
        filePath - Path to the desired file in a Polar device.
        Returns:

        ByteArray with payload data, payload may also be empty ByeArray.

      • writeFile

         abstract Unit writeFile(String identifier, String filePath, ByteArray fileData)

        Write any file over PFtp BLE client. API user must know the exact path to the desired file. API user must also take care of parsing the returned ByteArray payload to the desired data object. NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API.

        Parameters:
        identifier - Polar device ID or BT address
        filePath - Path to the directory in device in a Polar device.
        fileData - , file data in already serialized into ByteArray format.
        Returns:

        Success or error

      • deleteFileOrDirectory

         abstract Unit deleteFileOrDirectory(String identifier, String filePath)

        Delete any file or directory over PFtp BLE client. API user must know the exact path to the desired file. API user must also take care of parsing the returned ByteArray payload to the desired data object. NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API.

        Parameters:
        identifier - Polar device ID or BT address
        filePath - Path of the file or directory to be deleted at a Polar device.
        Returns:

        Success or error

      • getFileList

         abstract List<String> getFileList(String identifier, String directoryPath, Boolean recurseDeep)

        List all files in the given path

        Parameters:
        identifier - Polar device ID or BT address
        directoryPath - Path to the desired directory in a Polar device from which to list all files.
        recurseDeep - Recursion goes to the bottom of the file tree when true.
        Returns:

        List of files or error

      • createFolder

         abstract Unit createFolder(String identifier, String folderPath)

        Create a new folder on the device using the low-level PFTP API. The folder path must end with a '/'. If it does not, one will be appended automatically. NOTE: this is an experimental API intended for Polar internal use only. Polar will not support 3rd party users with this API.

        Parameters:
        identifier - Polar device ID or BT address
        folderPath - Path of the folder to create on the Polar device (e.g.
        Returns:

        Success or error