Theta-client (official SDK) v1.2 released with client mode, time-shift, previewFormat and more

craig · June 16, 2023, 11:39pm

theta-client is RICOH’s official SDK for the RICOH THETA camera line. It works with X, Z1, SC2, and V. The SDK is open source and works with iOS native, Android native, React Native and Flutter.

New features include:

time-shift
wireless LAN client mode
THETA X external memory card support
THETA X power saving and LCD screen control on/off support
control of preview format, shutter speed and WLAN frequency (2.4 or 5GHz) on Z, Z1, V

Eval Walkthrough for Android Demo Build

git clone https://github.com/ricohapi/theta-client.git
cd theta-client/
git checkout 1.2.0
git switch -c 1.2.0
./gradlew publishToMavenLocal
...
BUILD SUCCESSFUL in 46s

Using Android Studio Flamingo on Ubuntu 22.04

with RICOH THETA connected to workstation with WiFi.

Tip: Use two network interfaces

Flutter Build

The theta-client library works with different platforms (Android native, iOS native, React Native, Flutter). I’ll also test the Flutter demo using Flutter 3.10.5.

cd demo-flutter
flutter pub get
flutter run

screen_flutter

Testing new features

The short code snippets illustrate the use of dart enums to get the values of the new options. This is quite nice with the auto-completion of most editors. For example, in VSCode, I can see the available options for WLAN frequence with the . dot after the enum name.

You can also see all the options available in your code editor. This reduces errors for incorrect values and mismatched types.

To test the new theta-client features, I created a button on the demo screen.

Test for preview format, shutter speed

These are the three new options common across V, X, Z1

  TextButton(
      onPressed: () async {
        if (isInitialized) {
          debugPrint('THETA: theta is initialized');
          final options = await thetaClientFlutter.getOptions([
            OptionNameEnum.previewFormat,
            OptionNameEnum.shutterSpeed,
            OptionNameEnum.wlanFrequency,
          ]);
          debugPrint('THETA width: ${options.previewFormat}');
          debugPrint(
              'THETA shutter speed: ${options.shutterSpeed}');
          debugPrint(
              'THETA WLAN Frequency: ${options.wlanFrequency}');
        }
      },

Output

I/flutter (12041): THETA width: W1024_H512_F30
I/flutter (12041): THETA shutter speed: SHUTTER_SPEED_AUTO
I/flutter (12041): THETA WLAN Frequency: GHZ_2_4

THETA X specific: camera control source, camera mode, power saving

TextButton(
    onPressed: () async {
      if (isInitialized) {
        debugPrint('THETA: theta is initialized');
        final options = await thetaClientFlutter.getOptions([
          OptionNameEnum.cameraControlSource,
          OptionNameEnum.cameraMode,
          OptionNameEnum.powerSaving,
        ]);
        debugPrint(
            'THETA X - camera control source: ${options.cameraControlSource}');
        debugPrint(
            'THETA X - camera mode: ${options.cameraMode}');
        debugPrint(
            'THETA X - power saving: ${options.powerSaving}');
      }
    },
    child: const Text('check options')),

Output

I/flutter (12041): THETA X - camera control source: CAMERA
I/flutter (12041): THETA X - camera mode: CAPTURE
I/flutter (12041): THETA X - power saving: ON

Example using option in conditional check

WlanFrequencyEnum is an enum built into theta-client.

  if (options.wlanFrequency == WlanFrequencyEnum.ghz_5) {
    debugPrint('wlan is at 5GHz');
  } else {
    debugPrint('wlan is not at 5GHz');
  }
  if (options.wlanFrequency ==
      WlanFrequencyEnum.ghz_2_4) {
    debugPrint('wlan is at 2.4GHz');
  } else {
    debugPrint('wlan is not at 2.4GHz');
  }

Output

I/flutter (12041): wlan is at 5GHz
I/flutter (12041): wlan is not at 2.4GHz

full list of changes

Support wireless LAN client mode of THETA X, Z1 and V.
- Add following properties to ThetaRepository.Options class
Support time-shift shooting of THETA X, Z1 and V.
- Add TimeShiftCapture class
- Add following properties to ThetaRepository.Options class
  - timeShift
  - shootingMethod
Support an external memory card of THETA X.
- Add parameter storage to ThetaRepository.listFiles()
- Add property storageID to ThetaRepository.ThetaFiles
Add following properties to ThetaRepository.Options class for controlling THETA X.
Add following properties to ThetaRepository.Options class for controlling THETA.
- previewFormat
- shutterSpeed
- wlanFrequency for THETA X, Z1 and V

Assets 3

THETAClient.xcframework.zip

37.7 MB

Release 1.2.0 · ricohapi/theta-client

erikrod1 · June 26, 2023, 8:06pm

Hey, I’m working on the React Native version testing of v1.2 of Theta-client. I’ve found all the available Enums in this file. Currently getOptions only works for me to show up in the console, and I can’t get it to show up in a returned text component. I suspect that it has something to do with the way javascript promise returns work.

github.com

ricohapi/theta-client/blob/main/react-native/src/theta-repository/options/options.ts

import type { CameraControlSourceEnum } from './option-camera-control-source';
import type { CameraModeEnum } from './option-camera-mode';
import type { NetworkTypeEnum } from './option-network-type';
import type { PowerSavingEnum } from './option-power-saving';
import type { PreviewFormatEnum } from './option-preview-format';
import type { Proxy } from './option-proxy';
import type { ShootingMethodEnum } from './option-shooting-method';
import type { ShutterSpeedEnum } from './option-shutter-speed';
import type { TimeShift } from './option-time-shift';
import type { WhiteBalanceAutoStrengthEnum } from './option-white-balance-auto-strength';
import type { WlanFrequencyEnum } from './option-wlan-frequency';

/** Aperture value. */
export const ApertureEnum = {
  /** AUTO(0) */
  APERTURE_AUTO: 'APERTURE_AUTO',
  /** 2.0F RICOH THETA V or prior */
  APERTURE_2_0: 'APERTURE_2_0',
  /** 2.1F RICOH THETA Z1 and the exposure program (exposureProgram) is set to Manual or Aperture Priority */
  APERTURE_2_1: 'APERTURE_2_1',

This file has been truncated. show original

craig · June 26, 2023, 10:54pm

I haven’t looked too closely at the demo-react-native project. For Flutter, I had to wait for thetaClientFlutter.getOptions() to complete.

There may be a async/io problem with getting the text to appear on the React Native screen.

What are you using to manage state and update the screen? Are you using a react hook?

github.com

codetricity/theta-j-demo-end-tutorial/blob/81ca86c50237fc330e8795e08cf2174291a400eb/App.js#L18


      
          import { setImageButtonControl } from "./theta_control/set-image-button-control";
          import { styles } from "./styles";
          
          
export default function App() {
            // fake-theta
            // const urlEndpoint = "https://fake-theta.vercel.app/osc/";
            // real theta physical device in access point mode
            const urlEndpoint = "http://192.168.1.1/osc/";
          
          
  // end camera endpoint config
            const [responseWindow, onChangeResponseWindow] = useState(
              "press button to test API"
            );
          
          

          
  return (
              <ScrollView style={styles.container}>
                <View style={styles.headerContainer}>
                  <Text style={styles.headerText}>RICOH THETA JavaScript Demo</Text>
                </View>
                <View style={styles.buttonRow}>