StarMgsIO Android SDK Ver 1.5.0

Overview

This package contains StarMgsIO SDK Ver 1.5.0
starmgsio.jar is a library for supporting application development for Star scales.

1. Contents
   
2. Scope
   
3. Installation
   
4. API
   1. StarDeviceManager
   2. StarDeviceManager.InterfaceType
   3. StarDeviceManagerCallback
   4. ConnectionInfo
   5. ConnectionInfo.InterfaceType
   6. ConnectionInfo.Builder
   7. Scale
   8. ScaleCallback
   9. ScaleSetting
   10. ScaleOutputConditionSetting
   11. ScaleData
   12. ScaleData.Unit
   13. ScaleData.ComparatorResult
   14. ScaleData.DataType
   15. ScaleData.Status
5. Copyright
   
6. Release History
   

Contents

MG_series_Scale_StarMgsIO_Android_SDK_V1_5_0/
├── Documents/
│   └── readme.url                      // Link to release Notes
│── Software/
│   ├── SDK/                           // Samples (Ver 1.5.0)
│   └── Distributables/
│       └── starmgsio.jar              // starmgsio.jar (Ver 1.5.0)
└── SoftwareLicenseAgreement.pdf       // Software License Agreement

Scope

Supported models :

• MG-S Scale
• MG-S322
• MG-S1501
• MG-S8200
• MG-S322 USCA
• MG-S1501 USCA
• MG-S8200 USCA
• MG-T Scale
• MG-T12
• MG-T30
• MG-T60
• MG-T12 UDB
• MG-T30 UDB
• MG-T60 UDB

Supported OS :

• Android 9.0 - Android 14.0

Installation

StarMgsIO SDK library supports Maven Repository and JAR file. Please link library that suits your application configuration.

Use Maven Repository

1. Insert following code in app/build.gradle.

dependencies {
    implementation 'com.starmicronics:starmgsio:starmgsioVersion'
    ...
}

Please refer to app/build.gradle in SDK for the latest library version.

Use JAR File

1. In your app, please link starmgsio.jar located in Software/Distributables/.

2. Insert following code in app/build.gradle.

dependencies {
    implementation files('../../Distributables/starmgsio.jar')
    ...
}

Configuration

1. Please give permissions below in your AndroidManifest.xml. (These settings are related by BLE. (Required))
   ACCESS_FINE_LOCATION needs runtime permission.
   Please turn ON location permission(App info -> Permissions -> Location), or make your app to ask users to turn on the permission.
   

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.starmicronics.starmgsiosdk">

    <uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

    <!-- Declare this required feature if you want to make the app available to BLE-capable
         devices only.  If you want to make your app available to devices that don't support BLE,
         you should omit this in the manifest.  Instead, determine BLE capability by using
         PackageManager.hasSystemFeature(FEATURE_BLUETOOTH_LE) -->
    <uses-feature android:name="android.hardware.bluetooth_le" android:required="true"/>

    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

    <application>
        ...
    </application>

</manifest>

2. Add about use of USB connection. (Optional)
   In case of check on the checkbox of connection permission dialog, then the dialog will not be displayed even if the cable is inserted or removed unless the application is reinstalled. In addition, the sample application will automatically launch when you insert the cable.

Create "device_filter.xml" in res folder.

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <usb-device vendor-id="1305" product-id="4100" />
    <usb-device vendor-id="1305" product-id="4101" />
    <usb-device vendor-id="1305" product-id="4102" />
    <usb-device vendor-id="1305" product-id="4136" />
    <usb-device vendor-id="1305" product-id="4137" />
    <usb-device vendor-id="1305" product-id="4138" />
    <usb-device vendor-id="1305" product-id="4139" />
    <usb-device vendor-id="1305" product-id="4140" />
    <usb-device vendor-id="1305" product-id="4141" />
</resources>

And add next text in manifest.xml.

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.starmicronics.starmgsiosdk">

    ...

    <application
        ...>
        <activity
            ...
            android:exported="true">
            <intent-filter>
                <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
            </intent-filter>
            <meta-data android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" android:resource="@xml/device_filter" />
        </activity>

    </application>

</manifest>

API

StarDeviceManager

public class StarDeviceManager

This class is used to manage a scale.

Usage

mStarDeviceManager = new StarDeviceManager(ScanActivity.this, StarDeviceManager.InterfaceType.All);

Usage - scanForScales()

mStarDeviceManager.scanForScales(mStarDeviceManagerCallback);

See ScanActivity for more information.

Usage - createScale()

mScale = starDeviceManager.createScale(connectionInfo);

See ScaleActivity for more information.

StarDeviceManager.InterfaceType

public enum StarDeviceManager.InterfaceType

This enum is used to specify the StarDeviceManager's InterfaceType setting.

StarDeviceManagerCallback

public abstract class StarDeviceManagerCallback

This class is used to receive the result of processes done in the StarDeviceManager class.

private final StarDeviceManagerCallback mStarDeviceManagerCallback = new StarDeviceManagerCallback() {
    @Override
    public void onDiscoverScale(@NonNull ConnectionInfo connectionInfo) {
        Map item = new HashMap<>();
        item.put(INTERFACE_TYPE_KEY, connectionInfo.getInterfaceType().name());
        item.put(DEVICE_NAME_KEY, connectionInfo.getDeviceName());
        item.put(IDENTIFIER_KEY,  connectionInfo.getIdentifier());

        if(!mDataMapList.contains(item)) {
                mDataMapList.add(item);
                mAdapter.notifyDataSetChanged();
        }
    }
};

ConnectionInfo

public class ConnectionInfo

The following constants is used for ConnectionInfo class as any device identifier of scale(exclude BLE).

Data class to store the information to connect a scale

ConnectionInfo.InterfaceType

public enum ConnectionInfo.InterfaceType

This enum is used to specify the ConnectionInfo's InterfaceType setting.

ConnectionInfo.Builder

public static class ConnectionInfo.Builder

Builder class to generate the ConnectionInfo class instance.

Scale

public abstract class Scale

This class is used to communicate with a scale.

The following constants is used for ScaleCallback class as status code of scale.

ScaleCallback

public abstract class ScaleCallback

This class is used to receive the result of processes done in the Scale class.

ScaleSetting

public enum ScaleSetting

This enum is used to specify the scale setting.

ScaleOutputConditionSetting

public enum ScaleOutputConditionSetting

This enum is used to specify the scale output condition setting.

ScaleType

public enum ScaleType

This enum is used to specify the scale type.

ScaleData

public interface ScaleData

This interface manages weight data received from a scale.

ScaleData.Unit

public enum ScaleData.Unit

This enum is used to specify the unit of weight.

ScaleData.ComparatorResult

public enum ScaleData.ComparatorResult

This enum is used to specify the result of comparator function.

ScaleData.DataType

public enum ScaleData.DataType

This enum is used to specify the type of the data.

ScaleData.Status

public enum ScaleData.Status

This enum is used to specify the status of weight data.

Copyright

Copyright 2020 - 2023 Star Micronics Co., Ltd. All rights reserved.

Release History

Ver.1.5.0(US market only)
2023/10/31

• Supports MG-S322 USCA , MG-S1501 USCA and MG-S8200 USCA
• Supports MG-T12 UDB, MG-T30 UDB and MG-T60 UDB
• Support Android 14.

Ver.1.4.0(US market only)
2021/12/20

• Supports MG-T12, MG-T30 and MG-T60
• Support Android 12.

Ver.1.3.0(US market only)
2020/04/06

• Add feature for output condition settings. Please refer to below for details.
  • Scale#updateOutputConditionSetting method
  • ScaleCallback#onUpdateOutputConditionSetting method
  • ScaleOutputConditionSetting Constants

Ver.1.2.0 (US market only)
2019/12/25

• Changed project structure
  
  • Maven support for each library.

Ver.1.1.0 (US market only)
2019/08/19

• Add USB support.

Ver.1.0.0 (US market only)
2018/06/29

• First release.