pm16c16 package

class PM16C16(ip_address, port=7777, timeout_sec=3.0, logger=None, log_level='INFO')

ベースクラス: object

Python利用者向けI/F層。

通信オブジェクトを受け取り、通信層とデバイス制御層を内部で構成する。

パラメータ:

• ip_address (str)

• port (int)

• timeout_sec (float)

• log_level (str)

backlash(motor)

パラメータ:

motor (int)

戻り値の型:

int

display()

戻り値の型:

str

emergency_stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

emergency_stop_all()

戻り値の型:

None

hold(motor)

パラメータ:

motor (int)

戻り値の型:

str

home(motor)

パラメータ:

motor (int)

戻り値の型:

None

is_busy(motor)

パラメータ:

motor (int)

戻り値の型:

bool

limit(motor, side)

パラメータ:

• motor (int)

• side (str)

戻り値の型:

int

move(motor, pulse, backlash=True)

パラメータ:

• motor (int)

• pulse (int)

• backlash (bool)

戻り値の型:

None

number_to_rate(index)

パラメータ:

index (int)

戻り値の型:

float

pause()

戻り値の型:

None

pause_status()

戻り値の型:

str

position(motor)

パラメータ:

motor (int)

戻り値の型:

int

rate_number(motor)

パラメータ:

motor (int)

戻り値の型:

int

rate_to_number(rate)

パラメータ:

rate (float)

戻り値の型:

int

remote()

戻り値の型:

None

resume()

戻り値の型:

None

set_backlash(motor, backlash)

パラメータ:

• motor (int)

• backlash (int)

戻り値の型:

None

set_display(channel)

パラメータ:

channel (str)

戻り値の型:

None

set_display_all(motors)

パラメータ:

motors (Iterable[int])

戻り値の型:

None

set_hold(motor, enabled)

パラメータ:

• motor (int)

• enabled (bool)

戻り値の型:

None

set_limit(motor, side, pulse)

パラメータ:

• motor (int)

• side (str)

• pulse (int)

戻り値の型:

None

set_position(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_rate_number(motor, number)

パラメータ:

• motor (int)

• number (int)

戻り値の型:

None

set_speed(motor, speed)

パラメータ:

• motor (int)

• speed (int)

戻り値の型:

None

set_speed_mode(motor, mode)

パラメータ:

• motor (int)

• mode (int)

戻り値の型:

None

set_ttl_end_pulse(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_ttl_mode(motor, mode)

パラメータ:

• motor (int)

• mode (int)

戻り値の型:

None

set_ttl_period(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_ttl_start_pulse(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

speed(motor)

パラメータ:

motor (int)

戻り値の型:

int

speed_mode(motor)

パラメータ:

motor (int)

戻り値の型:

str

status(motor)

パラメータ:

motor (int)

戻り値の型:

MotorStatus

status_all()

戻り値の型:

list[MotorStatus]

stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

stop_all()

戻り値の型:

None

ttl_end_pulse(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_mode(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_output_start(motor)

パラメータ:

motor (int)

戻り値の型:

None

ttl_output_stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

ttl_period(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_start_pulse(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_status(motor)

パラメータ:

motor (int)

戻り値の型:

int

version()

戻り値の型:

VersionInfo

wait_stop(motor, timeout_sec=30.0, interval_sec=0.1)

パラメータ:

• motor (int)

• timeout_sec (float)

• interval_sec (float)

戻り値の型:

MotorStatus

Subpackages

• pm16c16.core package
  • Communication
    • Communication._close_after_error()
    • Communication._require_socket()
    • Communication.close()
    • Communication.connect()
    • Communication.disconnect()
    • Communication.is_connected
    • Communication.query()
    • Communication.receive()
    • Communication.send()
  • CommunicationError
  • MotorControlError
  • MotorStatus
    • MotorStatus.ccw_ls
    • MotorStatus.cw_ls
    • MotorStatus.from_single_response()
    • MotorStatus.hold_off
    • MotorStatus.hp_ls
    • MotorStatus.is_busy
    • MotorStatus.legacy_status_bits
    • MotorStatus.rotation_state
  • ProtocolError
  • Submodules
  • pm16c16.core.communication_tcp module
    • Communication
      • Communication._close_after_error()
      • Communication._require_socket()
      • Communication.close()
      • Communication.connect()
      • Communication.disconnect()
      • Communication.is_connected
      • Communication.query()
      • Communication.receive()
      • Communication.send()
  • pm16c16.core.data module
  • pm16c16.core.errors module
    • CommunicationError
    • MotorControlError
    • ProtocolError
  • pm16c16.core.motor_status module
    • MotorStatus
      • MotorStatus.ccw_ls
      • MotorStatus.cw_ls
      • MotorStatus.from_single_response()
      • MotorStatus.hold_off
      • MotorStatus.hp_ls
      • MotorStatus.is_busy
      • MotorStatus.legacy_status_bits
      • MotorStatus.rotation_state
• pm16c16.server_fastapi package
  • Subpackages
    • pm16c16.server_fastapi.clients package
      • Submodules
      • pm16c16.server_fastapi.clients.async_pm16c_client module
      • pm16c16.server_fastapi.clients.sync_pm16c_client module
    • pm16c16.server_fastapi.routers package
      • Submodules
      • pm16c16.server_fastapi.routers.pm16c_router_ctrl module
  • Submodules
  • pm16c16.server_fastapi.api_models module
  • pm16c16.server_fastapi.make module
  • pm16c16.server_fastapi.spec_ctrl module

Submodules

pm16c16.pm16c_ctrl module

class PM16C16(ip_address, port=7777, timeout_sec=3.0, logger=None, log_level='INFO')

ベースクラス: object

Python利用者向けI/F層。

通信オブジェクトを受け取り、通信層とデバイス制御層を内部で構成する。

パラメータ:

• ip_address (str)

• port (int)

• timeout_sec (float)

• log_level (str)

backlash(motor)

パラメータ:

motor (int)

戻り値の型:

int

display()

戻り値の型:

str

emergency_stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

emergency_stop_all()

戻り値の型:

None

hold(motor)

パラメータ:

motor (int)

戻り値の型:

str

home(motor)

パラメータ:

motor (int)

戻り値の型:

None

is_busy(motor)

パラメータ:

motor (int)

戻り値の型:

bool

limit(motor, side)

パラメータ:

• motor (int)

• side (str)

戻り値の型:

int

move(motor, pulse, backlash=True)

パラメータ:

• motor (int)

• pulse (int)

• backlash (bool)

戻り値の型:

None

number_to_rate(index)

パラメータ:

index (int)

戻り値の型:

float

pause()

戻り値の型:

None

pause_status()

戻り値の型:

str

position(motor)

パラメータ:

motor (int)

戻り値の型:

int

rate_number(motor)

パラメータ:

motor (int)

戻り値の型:

int

rate_to_number(rate)

パラメータ:

rate (float)

戻り値の型:

int

remote()

戻り値の型:

None

resume()

戻り値の型:

None

set_backlash(motor, backlash)

パラメータ:

• motor (int)

• backlash (int)

戻り値の型:

None

set_display(channel)

パラメータ:

channel (str)

戻り値の型:

None

set_display_all(motors)

パラメータ:

motors (Iterable[int])

戻り値の型:

None

set_hold(motor, enabled)

パラメータ:

• motor (int)

• enabled (bool)

戻り値の型:

None

set_limit(motor, side, pulse)

パラメータ:

• motor (int)

• side (str)

• pulse (int)

戻り値の型:

None

set_position(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_rate_number(motor, number)

パラメータ:

• motor (int)

• number (int)

戻り値の型:

None

set_speed(motor, speed)

パラメータ:

• motor (int)

• speed (int)

戻り値の型:

None

set_speed_mode(motor, mode)

パラメータ:

• motor (int)

• mode (int)

戻り値の型:

None

set_ttl_end_pulse(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_ttl_mode(motor, mode)

パラメータ:

• motor (int)

• mode (int)

戻り値の型:

None

set_ttl_period(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_ttl_start_pulse(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

speed(motor)

パラメータ:

motor (int)

戻り値の型:

int

speed_mode(motor)

パラメータ:

motor (int)

戻り値の型:

str

status(motor)

パラメータ:

motor (int)

戻り値の型:

MotorStatus

status_all()

戻り値の型:

list[MotorStatus]

stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

stop_all()

戻り値の型:

None

ttl_end_pulse(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_mode(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_output_start(motor)

パラメータ:

motor (int)

戻り値の型:

None

ttl_output_stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

ttl_period(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_start_pulse(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_status(motor)

パラメータ:

motor (int)

戻り値の型:

int

version()

戻り値の型:

VersionInfo

wait_stop(motor, timeout_sec=30.0, interval_sec=0.1)

パラメータ:

• motor (int)

• timeout_sec (float)

• interval_sec (float)

戻り値の型:

MotorStatus

pm16c16.pm16c_device module

class PM16CDevice(communication, channel_count=16, logger=None, log_level='INFO')

ベースクラス: object

PM16C-16固有のコマンド生成、応答解析、装置状態を担当する。

パラメータ:

• communication (Communication)

• channel_count (int)

• log_level (str)

static _check_motor(motor)

パラメータ:

motor (int)

戻り値の型:

None

static _normalize_side(side)

パラメータ:

side (str)

戻り値の型:

str

static _parse_display_status(raw)

パラメータ:

raw (str)

戻り値の型:

list[MotorStatus]

_query_motor_command(command, motor, suffix='')

パラメータ:

• command (str)

• motor (int)

• suffix (str)

戻り値の型:

str

_send_motor_command(command, motor)

パラメータ:

• command (str)

• motor (int)

戻り値の型:

None

_send_motor_value(command, motor, value)

パラメータ:

• command (str)

• motor (int)

• value (int)

戻り値の型:

None

_status_all_16()

戻り値の型:

list[MotorStatus]

_status_all_display()

戻り値の型:

list[MotorStatus]

all_reply(enabled)

パラメータ:

enabled (bool)

戻り値の型:

None

backlash(motor)

パラメータ:

motor (int)

戻り値の型:

int

display()

戻り値の型:

str

emergency_stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

emergency_stop_all()

戻り値の型:

None

high_speed(motor)

パラメータ:

motor (int)

戻り値の型:

int

hold(motor)

パラメータ:

motor (int)

戻り値の型:

str

home(motor)

パラメータ:

motor (int)

戻り値の型:

None

jog(motor, direction)

指定した軸をJOG移動させます。

パラメータ:

• motor (int) -- モータ番号（0～15）。

• direction (str) -- 移動方向。正転は「+」または「cw」、 逆転は「-」または「ccw」。

例外:

ValueError -- モータ番号または移動方向が無効な場合。

戻り値の型:

None

jog_stop(motor)

JOG移動を停止します（通常のstopと同じコマンドにマッピング）。

パラメータ:

motor (int)

戻り値の型:

None

limit(motor, side)

パラメータ:

• motor (int)

• side (str)

戻り値の型:

int

limit_status_bits(motor)

パラメータ:

motor (int)

戻り値の型:

int

local()

戻り値の型:

None

low_speed(motor)

パラメータ:

motor (int)

戻り値の型:

int

middle_speed(motor)

パラメータ:

motor (int)

戻り値の型:

int

move(motor, pulse, backlash=True)

パラメータ:

• motor (int)

• pulse (int)

• backlash (bool)

戻り値の型:

None

static number_to_rate(index)

パラメータ:

index (int)

戻り値の型:

float

pause()

戻り値の型:

None

pause_status()

戻り値の型:

str

position(motor)

パラメータ:

motor (int)

戻り値の型:

int

rate_number(motor)

パラメータ:

motor (int)

戻り値の型:

int

static rate_to_number(rate)

パラメータ:

rate (float)

戻り値の型:

int

remote()

戻り値の型:

None

resume()

戻り値の型:

None

set_backlash(motor, backlash)

パラメータ:

• motor (int)

• backlash (int)

戻り値の型:

None

set_display(channel)

パラメータ:

channel (str)

戻り値の型:

None

set_display_all(motors)

パラメータ:

motors (Iterable[int])

戻り値の型:

None

set_high_speed(motor, speed)

パラメータ:

• motor (int)

• speed (int)

戻り値の型:

None

set_hold(motor, enabled)

パラメータ:

• motor (int)

• enabled (bool)

戻り値の型:

None

set_limit(motor, side, pulse)

パラメータ:

• motor (int)

• side (str)

• pulse (int)

戻り値の型:

None

set_low_speed(motor, speed)

パラメータ:

• motor (int)

• speed (int)

戻り値の型:

None

set_middle_speed(motor, speed)

パラメータ:

• motor (int)

• speed (int)

戻り値の型:

None

set_motor_free(motor, free=True)

モータの励磁状態を設定します。

パラメータ:

• motor (int) -- モータ番号（0～15）。

• free (bool) -- Trueの場合は励磁をOFFにしてフリー状態にします。 Falseの場合は励磁をONにしてホールド状態にします。

例外:

ValueError -- モータ番号が範囲外の場合。

戻り値の型:

None

set_position(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_rate_number(motor, number)

パラメータ:

• motor (int)

• number (int)

戻り値の型:

None

set_speed(motor, speed)

パラメータ:

• motor (int)

• speed (int)

戻り値の型:

None

set_speed_mode(motor, mode)

パラメータ:

• motor (int)

• mode (int | str)

戻り値の型:

None

set_speed_profile(motor, low_speed, mid_speed, high_speed)

パラメータ:

• motor (int)

• low_speed (int)

• mid_speed (int)

• high_speed (int)

戻り値の型:

None

set_ttl_end_pulse(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_ttl_mode(motor, mode)

パラメータ:

• motor (int)

• mode (int)

戻り値の型:

None

set_ttl_period(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

set_ttl_start_pulse(motor, pulse)

パラメータ:

• motor (int)

• pulse (int)

戻り値の型:

None

speed(motor)

パラメータ:

motor (int)

戻り値の型:

int

status(motor)

パラメータ:

motor (int)

戻り値の型:

MotorStatus

status_all()

戻り値の型:

list[MotorStatus]

status_bits(motor)

パラメータ:

motor (int)

戻り値の型:

int

stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

stop_all()

戻り値の型:

None

ttl_end_pulse(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_mode(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_output_start(motor)

パラメータ:

motor (int)

戻り値の型:

None

ttl_output_stop(motor)

パラメータ:

motor (int)

戻り値の型:

None

ttl_period(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_start_pulse(motor)

パラメータ:

motor (int)

戻り値の型:

int

ttl_status(motor)

パラメータ:

motor (int)

戻り値の型:

int

version()

戻り値の型:

VersionInfo

zero_position(motor)

指定軸の現在位置カウンタを 0 にリセットします。

パラメータ:

motor (int)

戻り値の型:

None

pm16c16.version_info module

class VersionInfo(raw)

ベースクラス: object

装置の VER? 応答を解析して保持する。

想定形式は <version> <date> <model>。日付の有無やモデル名中の 空白は許容するが、空応答とバージョン番号を含まない応答は拒否する。

パラメータ:

raw (str)

_DATE_PATTERN = re.compile('^\\d{2,4}[-/]\\d{1,2}[-/]\\d{1,2}$')

_VERSION_PATTERN = re.compile('^\\d+(?:\\.\\d+)+$')

property is_pm16c16: bool

property is_pm2cd: bool

property normalized_model: str