2020/05/31

CPU温度を取得するスクリプトを作成(Linux)

背景

PCでのソフトウェアのヒートランを行った際、CPUの温度をモニタリングする必要があったため、スクリプトを作成した。

記事の目的

CPUの温度を取得するスクリプトを作成する

lm-sensors

ここでは、CPUの温度を取得するスクリプトの記述方法について記載する。

必要パッケージの導入

CPUの温度を取得するために必要なパッケージをインストールする
  1. sudo apt install lm-sensors

スクリプトの作成方法

スクリプトの作成方法は以下の通りである。
  1. スクリプトcpu_temperature_monitoring.shを作成する
    1. #!/bin/bash
    2. echo "Start to record CPU temperature!"
    3. DIR_NAME=~/cpu_temperature_log/`date +%Y%m%d`
    4. LOG_NAME=./`date +%Y%m%d_%H%M%S`_cpu_temperature.log
    5. mkdir -p $DIR_NAME
    6. cd $DIR_NAME
    7. echo "Date,Temperature[C]" >> $LOG_NAME
    8. while :
    9. do
    10.     sensors | grep "Core 0:" | grep -o [+-][0-9][0-9][.][0-9] | awk '{ "date +\"%Y/%m/%d %T\"" | getline var; print var "," $0 }' >> $LOG_NAME
    11.     sleep 1
    12. done
    13. exit 0
  2. スクリプトに実行権限を与える
    1. $ chmod 777 ./cpu_temperature_monitoring.sh

スクリプトの実行方法

実行方法は以下の通りである。
  1. $ ./cpu_temperature_monitoring.sh
  2. Start to record CPU temperature!
~/cpu_temperature_monitoring_log/日付/にCPU温度のログが作成される
  1. $ less ./cpu_temperature_log/20190923/20190923_234227_cpu_temperature.log
  2. Date,Temperature[C]
  3. 2019/09/23 23:42:27,+51.0
  4. 2019/09/23 23:42:28,+51.0
  5. 2019/09/23 23:42:29,+51.0
  6. 2019/09/23 23:42:30,+52.0

備考

  • grepで特定の文字列だけを抽出するオプションは、-o

まとめ

  • CPUの温度を取得するスクリプトを作成した

参考文献


変更履歴

  1. 2020/05/31: 新規作成
時刻: 0 件のコメント:
ラベル: , , , ,

2020/05/24

内部仕様書のテンプレート

背景

仕事の中でシステムやソフトウェアの開発を行う際、内部仕様書を書く機会が増えてきたので、外部仕様書に必要な項目をまとめた。


記事の目的

内部仕様書を効率的に作成するため、内部仕様書のテンプレートを作成する


内部仕様書とは

内部仕様書は、詳細設計とも呼ばれている。外部仕様書の目的は、複数名で開発を行う場合、外部設計の結果を受けて効率的に実装作業を行えるように実装内容を整理することである。


内部仕様書の全体構成


外部仕様書の船体構成は、下記の通りである。
  • クラス図
    • システムを構成するクラスとクラス間の関係を表す。
  • 内部データ
    • システム内部で使用するデータ一覧(データ名、データ型、データ長、その他制約)について記載する。
  • 機能
    • 下記の項目を機能毎に作成する。
    1. 機能名
      2. 機能名を記載する。
    2. 入出力値
      3. 入出力値のデータ名、データ型、データ長、その他制約について記載する。
    3. 他の機能モジュールとの関係性
      4. 他の機能モジュールとの関連性(データの流れ、データ名)について記載する。
    4. アクティビティ図
      5. 処理内容をアクティビティ図で記載する。
    5. シーケンス図
      6. 処理詳細をシーケンス図で記載する。


まとめ

  • 内部仕様書のテンプレートに関して記述した


参考文献



変更履歴

  1. 2020/05/24: 新規作成



時刻: 0 件のコメント:
ラベル:

2020/05/23

ROSでcatkin_makeする際にundefined referenceが出る原因まとめ

背景

ROS melodicでOSSパッケージを利用した開発を行う中で、make時にundefined reference to...(に対する定義されていない参照です)のエラーが発生する場合があったため、原因をまとめておく。

記事の目的

ROSのOSSパッケージを利用する際、make時にundefined reference to...のエラーが出る原因をまとめる

undefined reference

現象

GitHubでOSSのパッケージをcloneしてcatkin_makeする際、下記のようなエラーが出る場合がある
  1. $ catkin_make ...
  2. ...
  3. /opt/ros/melodic/lib/libtf.so: undefined reference to tf2_ros::TransformListener::TransformListener(tf2::BufferCore&, ros::NodeHandle const&, bool)'
  4. collect2: error: ld returned 1 exit status
  5. ...

原因

原因として、下記が考えられる。
  • OSSパッケージのバージョン違い
    • rosには、ディストリビューション毎にバージョンが変更され、tfなどの標準パッケージの仕様が変更される場合がある。 よって、git cloneしたパッケージのバージョンが異なると、make時にエラーとなる場合がある。

対処方法

  • OSSパッケージのバージョン違い
    • OSSパッケージのgitブランチを確認し、バージョンを合わせる
    1. ブランチを確認する
      1. $ cd < OSSパッケージののルートディレクトリ >
      2. $ git branch
      3. noetic-devel # ros noetic用のブランチ
    2. ブランチを変更する
      1. $ git checkout <現在のROSのブランチ>
      2. <現在のROSのブランチ>

まとめ

  • ROSのOSSパッケージを利用する際、make時にundefined reference to...のエラーが出る原因をまとめた


参考文献



変更履歴

  1. 2020/05/23: 新規作成
時刻: 0 件のコメント:
ラベル:

2020/05/21

外部仕様書のテンプレート

背景

仕事の中でシステムやソフトウェアの開発を行う際、外部仕様書を書く機会が増えてきたので、外部仕様書に必要な項目をまとめた。

記事の目的

外部仕様書を効率的に作成するため、外部仕様書のテンプレートを作成する

外部仕様書とは

外部仕様書は、基本設計書もとも呼ばれている。外部仕様書の目的は、要件定義の結果を受けて、具体的なシステム構成や機能に記載した文書である。

外部仕様書の全体構成

外部仕様書の全体構成は、下記の通りである。
  1. 処理設計
    1. システム化の背景・目的
      2. システム化が必要な背景(理由)と目的を簡潔に記載する。
    2. (オプション)システム化の対象範囲
      3. 対象処理のシステム化範囲を明確に記載する。新規の場合は不要。
    3. システム機能要件一覧
      4. システムの機能要件について、一覧で記載する。
      • 分類
      • 機能名
      • 利用者
      • 機能概要
      • 重要度
      • 優先度
    4. 処理フロー
      5. システム全体の処理の流れについて記載する。
      UML図のアクティビティ図を使用すると良い。
    5. ユースケースシナリオ
      6. システム全体の処理をユースケースごとに分解し、そのシナリオについて記載する。
      UML図のユースケース図やシーケンス図を使用すると良い。
  2. システム方式設計
    1. ハードウェア構成図
      2. システムを実現するためのハードウェア構成について記載する。
      UML図の配置図を使用すると良い。
    2. ソフトウェア構成図
      3. システムを実現するためのソフトウェア構成について記載する。
      • OS
        • Windows、Mac-OS、Unix、Linux、iOS、AndroidなどのOSについて記載する。
      • ミドルウェア
        • DB(Oracle、DB2、SQL Server、MySQL、PostgreSQL)、Webサーバ(Apache、nginx、IIS)、APサーバ(WAS、Tomcat、WebLogic、JBoss、Interstage)などのミドルウェアについて記載する。
    3. ネットワーク構成図
      4. システムを実現するためのネットワーク構成について記載する。
      UML図の配置図を使用すると良い。
    4. アプリケーション機能構成
      5. 開発するシステム機能が階層的に分かる資料を作成する。
      機能要件とアプリケーション機能の関係性を明示するとともに、機能の分類、整理を行い記載する。
      • 分類
      • 機能名
      • 利用者
      • 処理タイミング
      • 処理内容
  3. アプリケーション機能設計
    1. 画面設計
      1. 画面一覧
        2. 開発する画面の一覧について記載する。
        • 分類
        • 画面名
        • 説明
        • 関連機能名
      2. 画面遷移図
        3. 画面がどの順番で遷移するか記載する。
      3. 画面レイアウト
        4. 各画面の詳細なレイアウトについて記載する。
      4. 画面入出力項目一覧
        5. 各画面で表示する内容と、入力する内容について記載する。
      5. 画面アクション定義
        6. 画面操作が行われた時の処理内容について記載する。
    2. バッチ設計
      1. バッチ処理一覧
        2. バッチ処理の一覧について記載する。
        • バッチ処理名
        • 処理概要
        • 処理周期
        • 処理タイミング
        • 関連機能名
      2. バッチ処理定義
        3. バッチ処理の具体的な入出力と処理内容について記載する。
        • 入力データ
        • 処理内容
        • 出力データ
      3. バッチ処理フロー
        4. バッチ処理の流れについて記載する。 UMLのシーケンス図を使用すると良い。
    3. DBテーブル・ファイル設計
      1. テーブル・ファイル一覧
        2. システムで用いるDBのテーブル一覧について記載する。
      2. テーブル関連図
        3. システムで用いるDBのテーブルの関係性について記載する。 UMLのER図を使用すると良い。
      3. テーブル定義
        4. テーブル内の項目名、データ型、データ長、その他制約について記載する。
      4. ファイル定義
        5. ファイル内の項目名、データ型、データ長、その他制約について記載する。
      5. CRUD図
        6. 各テーブルについて、どの機能で作成、参照、更新、削除がされるかについて記載する。
        C: 作成(Create)、R: 参照(Read)、U: 更新(Update)、D: 削除(Delete)
    4. 外部インターフェース設計
      1. 外部インターフェース一覧
        2. 外部システムとの界面(インターフェース)の一覧を記載する。
        • インターフェース名
        • 入出力の種別
        • 相手先システム名
        • 接続方式
        • 通信タイミング
      2. 外部システム関連図
        3. 外部システムとのデータ連携について記載する。
        UML図の配置図を使用すると良い。
      3. 外部インターフェース項目定義
        4. 外部システムと連携するデータについて記載する。(データ型、データ長、その他制約)
      4. 外部インターフェース処理概要
        5. システム間のデータ連携方式(リソース共有（データベース共有、ディスク共有）、アプリケーション連携（RPC、Webサービスなど）、ファイル連携、メッセージング)について記載する。
  4. 非機能要件設計
    1. 性能設計
      2. 要件定義の性能要件に対して、対応方針や評価方法について記載する。
      • 基準値
        • 画面応答時間、バッチ実行時間など、基準となる定量的な値を記載する。
      • 対策
        • 上記基準を満たすための、アプリケーション機能やプラットフォーム設計等への対策について記載する。
      • 評価方法
        • テスト段階において、上記基準を満たしているか判定する方法について記載する。
    2. 信頼性設計
      3. 要件定義の可用性と完全性の要件に対しての対応方針について記載する。
      • 可用性
        • 可用性基準値
          • 要件定義で定めた基準値を記載する。(例: 稼働率99.999%)
        • 可用性対策
          • アプリケーション機能(例: 障害発生時の復旧方法)やプラットフォーム設計等(例:システム多重化、縮退運用)への対策について記載する。
        • 可用性評価方法
          • テスト段階において、上記基準を満たしているか判定する方法について記載する。
      • 完全性
        • 完全性基準値
          • 要件定義で定めた基準値を記載する。
        • 完全性対策
          • 上記基準を満たすための、アプリケーション機能(例: データバックアップや更新ログの取得)やプラットフォーム設計(例: ディスクバックアップ、アクセスログ取得)等への対策について記載する。
        • 完全性評価方法
          • テスト段階において、上記基準を満たしているか判定する方法について記載する。
    3. 拡張性設計
      • 規模の拡張性
        • 要件定義で定めた性能拡張の実現方法について記載する。。
      • 機能の拡張
        • 要件定義で定めた機能拡張の実現方法について記載する。。
    4. 情報セキュリティ設計
      5. 要件定義のセキュリティ要件に対しての対応方針について記載する。
      • 利用者等の認証
        • 利用者認証(利用者自身、利用者の知っているもの、利用者が持っているものを用いた認証)の方式について記載する。
      • 権限管理
        • アカウント管理(登録、更新、停止、削除)の方法について記載する。
      • アクセス管理
        • 利用者の職務に応じて利用機能を制限する方法について記載する。
      • ログ管理
        • システムの利用記録・検索方法について記載する。
      • 暗号化機能
        • 保存したデータや通信するデータの暗号化方式について記載する。
      • 不正プログラム対策
        • コンピュータウィルス感染防止の対策方式について記載する。
      • 通信の制御
        • 不正通信の遮断方式について記載する。
    5. テスト方針
      6. 各テストについて、システムの品質を担保するために必要なテストの種類や目的、方法、開始条件、実施内容、テスト環境、テストデータの準備方針、実施タイミング、役割分担、報告書等の方針について記載する。
      • 単体テスト(MT, UT)
        • プログラムを構成する比較的小さな単位（ユニット）が個々の機能を正しく果たしているかどうかを検証するテストのことである。
      • 結合テスト(IT)
        • システム開発におけるプログラムの検証作業の中でも、手続きや関数といった個々の機能を結合させて、うまく連携・動作しているかを確認するテストのことである。
      • システムテスト(ST)
        • システム開発におけるプログラムの検証作業の中でも、構築したシステムが全体として予定通りの機能を満たしているかどうかを確認するテストのことである。
      • 運用テスト(OT)
        • システム開発においていくつかあるテスト工程の中で、本番稼働直前、テスト工程の一番最後に行う確認テストのことである。
    6. 移行方針
      7. 要件定義に基づき、システム移行に関する下記のような方針について記載する。
      • 移行スケジュール
        • 全体の開発、導入スケジュールについて記載する。
      • プログラム移行
        • プログラムの移行手順について記載する。
      • 初期データ登録
        • 新たなデータの登録方法について記載する。
      • 既存システムからのデータ移行
        • 既存システムからのデータの移行方法について記載する。
      • 役割分担
        • 担当者について記載する。
    7. 運用保守設計
      8. 要件定義に基づき、各要件を実現するに当たっての運用保守業務設計、および必要な環境や機能の設計について記載する。
      • 運用保守業務内容
        • 運用保守で対応する内容一覧を記載する。
      • 役割分担と対象範囲
        • 担当者と担当範囲について記載する。
      • 管理項目
        • 運用保守で対応する機能項目について記載する。
      • 必要なシステムやドキュメント
        • 運用保守を行うために必要なドキュメント一覧を記載する。
      • システム監視方法
        • システムの監視方法(定期的なログ確認、アラート機能)について記載する。
      • データ管理方法（ログなど）
        • データの保存場所や運用方法について記載する。
      • バックアップ方法
        • バックアップ先やタイミング、手法について記載する。
      • 障害対応方法
        • 障害発生時の対応手順について記載する。

まとめ

  • 外部仕様書のテンプレートに関して記述した

参考文献


変更履歴

  1. 2020/05/21: 新規作成



時刻: 0 件のコメント:
ラベル:

2020/05/18

要件定義書のテンプレート

背景

仕事の中でシステムやソフトウェアの開発を行う際、要件定義書を書く機会が増えてきたので、要件定義書に必要な項目をまとめた。

記事の目的

要件定義書を効率的に作成するため、要件定義書のテンプレートを作成する

要件定義書とは

要件定義書は、開発仕様書とも呼ばれている。要件定義書の目的は、開発にかかわるすべての技術者に開発する製品（新規の開発およびバージョンアップ）が備えるべき要件を決定事項として周知することである。

要件定義書の全体構成

要件定義書の全体構成は、下記の通りである。
  1. 処理要件の定義
    1. 処理概要
      1. 背景と目的
        2. システム化が必要な背景(理由)と目的を簡潔に記載する。
      2. 用語・略語の定義
        3. システム化対象処理にて使用する専門的な用語・略語の説明を記載する。
      3. 処理の概要
        4. システム化対象の処理の概要を記載する。
        UMLのアクティビティ図を利用すると良い。
      4. (オプション)現行システム概要
        5. 現行システムの概要を記載する。新規の場合は不要。
        • ハードウェア構成
          • 現行システムのハードウェア一覧について記載する。
        • ネットワーク構成
          • 現行システムのネットワーク構成について記載する。
          UMLの配置図を利用すると良い。
        • システム機能一覧（UI、UX）
          • 現行システムの機能一覧について記載する。
        • ミドルウェア構成
          • 現行システムで使用しているミドルウェア(Web、AP、DB)について記載する。
        • データ一覧（テーブルやファイル）
          • 現行システムで使用しているデータ形式一覧について記載する。
        • 外部インターフェース一覧
          • 現行システムの外部との界面(インターフェース)について記載する。
    2. 規模
      3. システム化対象処理の利用者数など、処理の規模を記載する。
    3. 時期・時間
      4. システム化対象処理の稼働時間を記載する。
    4. 場所
      5. システム化対象処理が関係する場所や組織について概要を記載する。
    5. 管理すべき指標
      6. システム化対象処理にて、管理すべき指標(KPI)を記載する。
    6. (オプション)システム化範囲
      7. 対象処理のシステム化範囲を明確に記載する。新規の場合は不要。
  2. 機能要件の定義
    1. システム機能要件
      2. システム機能一覧について記載する。
      • 機能名
        • 機能の名称について記載する。
      • 機能種別（表示(出力)、入力、処理、保存、削除）
        • 機能の種別について記載する。
      • 処理概要
        • 処理の概要について記載する。
      • 利用者
        • 機能を利用する対象者について記載する。
    2. UI、UX要件
      3. システムの表示(大きさや位置)や入力(入力方法など)に関する要件を記載する。
    3. データ要件
      4. 保管するデータ項目の一覧やデータ量の想定件数を記載する。
      UMLのER図を利用すると良い。
    4. 外部インターフェース要件
      5. 処理連携やデータの授受を行う他システムについて記載する。
      • 外部インターフェース名
        • 外部インターフェースの名称を記載する。
      • 外部インターフェース概要
        • 外部インターフェースの概略を記載する。
      • 連携方式（バッチorオンライン）
        • 連携する方法を記載する。
      • 送受信区分
        • データの流れを記載する。
      • 相手先システム
        • 外部インターフェースで接続されるシステムについて記載する。
      • 送受信タイミング
        • データの送受信タイミングについて記載する。
      • 送受信方式
        • データの送受信の方式(リソース共有（データベース共有、ディスク共有）、アプリケーション連携（RPC、Webサービスなど）、ファイル連携、メッセージング)について記載する。
  3. 非機能要件の定義
    1. ユーザビリティ要件
      2. システムの利用者について、ITリテラシーの水準を記載する。
    2. アクセシビリティ要件
      3. システム利用者の特性を受けて、今回開発システムに求める使いやすさを記載する。
      • 画面構成
      • 操作のしやすさ、分かりやすさ
      • 指示や状態の分かりやすさ
      • エラーの防止と処理
      • ヘルプ（ヘルプ情報やマニュアルなどの参照）
    3. システム方式要件
      4. システム構成の方針、全体構成図、開発方式や手法などについて記載する。
      1. システム構成の方針
        • システムアーキテクチャ
          • Webサーバなどの使用するアーキテクチャについて記載する。
        • アプリケーションプログラムの設計方式
          • 設計時の機能分割やコンポーネントの再利用の方針について記載する。
        • ソフトウェア製品の活用方式
          • OSSなどの外部ソフトウェアの利用方針について記載する。
        • システム基盤の方針
          • 処理や保存するデータ量や利用者の増加（拡張性）について記載する。
      2. システム全体構成
        3. プラットフォーム（ネットワーク、ハードウェア、OS ・ミドルウェア）の構成について記載する。
        UMLの配置図を利用すると良い。
      3. 開発方式や開発手法
        1. 開発方式
          2. スクラッチ開発、パッケージを使った開発などの開発方式について記載する。
        2. 開発手法
          3. ウォーターフォール、プロトタイピング、スパイラル、アジャイルなどの開発手法について記載する。
    4. 規模要件
      5. システム化において必要な機器数やデータ量、処理件数などを記載する。
      • 機器数
        • サーバー、クライアント端末などの機器の数について記載する。
      • データ量
        • テーブル毎のデータ量について記載する。 「データ要件」に記載の場合は、そちらを参照する旨を記載する。
      • 処理件数
        • システム機能毎にピーク時の処理件数について記載する。
    5. 性能要件
      6. システムの応答時間について記載する。
    6. 信頼性要件
      • 可用性
        • システムの稼働率について記載する。(例: 稼働率99.999%)
      • 完全性
        • 機器の破損やデータ欠損、不整合への対策、ログの取得について記載する。
    7. 拡張性要件
      • 性能の拡張性
        • 扱える利用者やデータ量の増加などの性能拡張の可否について記載する。
      • システム機能の拡張性
        • システムに新たな機能を追加可能かなどの機能拡張の可否について記載する。
    8. 上位互換性要件
      9. OSやソフトウェアのバージョンアップにおける要件について記載する。
    9. 継続性要件
      10. 大規模災害時における復旧目標時間やデータバックアップについて記載する。
    10. 情報セキュリティ要件
      11. 開発するシステムが満たすべきセキュリティの要件を記載する。
      • 利用者等の認証
        • 利用者認証(利用者自身、利用者の知っているもの、利用者が持っているものを用いた認証)の方式について記載する。
      • 権限管理
        • アカウント管理(登録、更新、停止、削除)の方法について記載する。
      • アクセス管理
        • 利用者の職務に応じて利用機能を制限する方法について記載する。
      • ログ管理
        • システムの利用記録・検索方法について記載する。
      • 暗号化機能
        • 保存したデータや通信するデータの暗号化方式について記載する。
      • 不正プログラム対策
        • コンピュータウィルス感染防止の対策方式について記載する。
      • 通信の制御
        • 不正通信の遮断方式について記載する。
    11. 情報システム稼働環境要件
      12. システム稼働可能な環境要件について記載する。
      • ハードウェア構成図
        • 最低限必要なハードウェア構成について記載する。
      • ソフトウェア構成図
        • 最低限必要なソフトウェア構成について記載する。
      • ネットワーク構成図
        • 最低限必要なネットワーク構成について記載する。 UMLの配置図を利用すると良い。
    12. テスト要件
      13. 各テストについて、システムの品質を担保するために必要なテストの種類や目的、方法、実施内容、範囲、報告書等の要件について記載する。
      • 単体テスト(MT, UT)
        • プログラムを構成する比較的小さな単位（ユニット）が個々の機能を正しく果たしているかどうかを検証するテストのことである。
      • 結合テスト(IT)
        • システム開発におけるプログラムの検証作業の中でも、手続きや関数といった個々の機能を結合させて、うまく連携・動作しているかを確認するテストのことである。
      • システムテスト(ST)
        • システム開発におけるプログラムの検証作業の中でも、構築したシステムが全体として予定通りの機能を満たしているかどうかを確認するテストのことである。
      • 運用テスト(OT)
        • システム開発においていくつかあるテスト工程の中で、本番稼働直前、テスト工程の一番最後に行う確認テストのことである。
    13. 移行要件
      14. システム移行に関する下記のような要件について記載する。
      • 移行スケジュール
        • 全体の開発、導入スケジュールについて記載する。
      • プログラム移行
        • プログラムの移行手順について記載する。
      • 初期データ登録
        • 新たなデータの登録方法について記載する。
      • 既存システムからのデータ移行
        • 既存システムからのデータの移行方法について記載する。
      • 役割分担
        • 担当者について記載する。
    14. 引継ぎ要件
      15. システム開発企業と、システム運用企業が異なる場合は、運用企業への引継ぎ要件について記載する。 具体的には、ドキュメントやトレーニング(対象者、スケジュール、実施場所、内容)について記載する。
    15. 教育要件
      16. システム利用者への操作教育について、下記のような観点で記載する。
      • 教育対象者
      • 教育の内容
      • 教育の実施時期
      • 教育の方法
      • 教材
      • 教育対象者数
    16. 運用要件
      17. システム運用(定常運用、随時運用、障害時運用のそれぞれ)における要件について記載する。
      • 運転管理及び監視
        • システム稼働監視、障害時の対応、報告内容や報告頻度について記載する。
      • 運用実績の評価と改善
        • 運用業務の内容や工数、報告内容や報告頻度について記載する。
      • システム操作
        • バックアップやアカウントの管理、ウィルスチェックの方法について記載する。
      • 運用サポート
        • 操作研修や問い合わせ対応について記載する。
      • 業務運用支援
        • データ作成支援や問い合わせ対応について記載する。
      • システムの現況確認
        • 各種管理台帳の提出方式について記載する。
    17. 保守要件
      18. システムの保守における要件について記載する。
      • プログラム
        • 保守の受付時間、対応時間について記載する。
      • ハードウェア
        • 保守の受付時間、対応時間について記載する。
      • ソフトウェア製品
        • 保守の受付時間、対応時間について記載する。
      • データ保守実績の評価と改善
        • 保守業務の内容や工数、報告内容や報告頻度について記載する。

まとめ

  • 要件定義書のテンプレートに関して記述した

参考文献


変更履歴

  1. 2020/05/18: 新規作成



時刻: 0 件のコメント:
ラベル:

2020/05/16

NECルータの設定方法

背景

Windows環境からコンソール経由でNEC社製ルータをセットアップする必要があったため、調査した。

記事の目的

NECルータを設定できるようにする

NECルータ

国内では、業界3位のシェアを誇るルータである。(1位:cisco、2位:Yamaha)
ギガビット回線とワイヤレス回線に対応したルータ(IX2000シリーズ、IX3000シリーズ)、有線とモバイルを1台で収容可能なルータ(WA2600-APシリーズ、WA1500 シリーズ)などがある。

ルータへの接続方法

  1. コンソールケーブルを使用し、PCとルータのCOMポートを接続する
  2. 接続方法詳細は、RLoginでシリアルコンソール接続を参照

ルータの設定方法

ここでは、ルータの基本的な設定方法について記載する。ターミナルには、RLoginを使用した。
  1. ルーターにログインする
    1. login admin
    2. Password: admin
    3. NEC Portable Internetwork Core Operating System Software
    4. Copyright Notices:
    5. Copyright (c) NEC Corporation 2001-2014. All rights reserved.
    6. Copyright (c) 1985-1998 OpenROUTE Networks, Inc.
    7. Copyright (c) 1984-1987, 1989 J. Noel Chiappa
    8. Router#
    loginユーザー名、パスワードを入力する。
  2. 現在の設定を確認する
    1. Router# show running-config
    2. ...
    3. interface GigaEthernet0.0
    4.  ip address 192.168.2.100/24
    5.  ipv6 address 2001:db8:200::1/64
    6.  no shutdown
    7. interface GigaEthernet1.0 
    8. ...
    show running-configで現在の設定を確認できる。
  3. コンフィグモードに変更する
    1. Router# enable-config
    2. Router(config)#
    機種によってはenableを使用する。 
    1. Router# enable
    2. Router(config)#
    コンフィグモードになると、設定の変更ができるようになる。
  4. インターフェースにIPアドレスを設定する
    1. 設定したいインターフェースを指定する
      1. Router(config)# interface GigaEthernet0.0
      2. Router(config-GigaEthernet0.0)#
      ここでは、GigaEthernet0.0を選択した。
    2. インターフェースのIPアドレスを設定する
      1. Router(config-GigaEthernet0.0)# ip address 192.168.1.1/24
      ここでは、192.168.1.1を選択した。
    3. インターフェースを有効化する
      1. Router(config-GigaEthernet0.0)# no shutdown
      無効化時は、shutdownと入力する。
    4. 設定を確認する
      1. Router(config-GigaEthernet0.0)# show ip address
      2. Interface GigaEthernet0.0 is up, line protocol is up
      3.  Internet address is 192.168.1.1/24
      4.  Broadcast address is 255.255.255.255
      5. Address determined by config
    5. インターフェースの指定を解除する
      1. Router(config-GigaEthernet0.0)# exit
      2. Router(config)#
  5. モバイルインターフェース(LTEなど)にIPアドレスを設定する
    1. 設定したいインターフェースを指定する
      1. Router(config)# interface MobileEthernet0.0
      2. Router(config-MobileEthernet0.0)#
      ここでは、MobileEthernet0.0を選択した。
    2. インターフェースに各種設定をする
      • IPアドレスをDHCPとする(SIMに依存する)
        1. Router(config-MobileEthernet0.0)# ip address dhcp
      • NAPT(ネットワークアドレス変換)を有効にする
        1. Router(config-MobileEthernet0.0)# ip napt enable
        これを有効にすることで、内部ネットワーク(例では、192.168.1.XX)の端末がモバイルネットワークと通信できる。

      • SIMの情報に基づいて、モバイルの設定を行う
        1. Router(config-MobileEthernet0.0)# mobile id "SIMに記載のモバイル会社のID"
        2. Router(config-MobileEthernet0.0)# mobile username "SIMに記載の接続用username"
        3. Router(config-MobileEthernet0.0)# mobile password encrypted "SIMに記載の接続用パスワード"
      • 自動で接続するように設定する
        1. Router(config-MobileEthernet0.0)# auto-connect
      • (オプション)セキュリティ対策のため、送信するポートをポート番号100(TCP)に制限する
        1. Router(config-MobileEthernet0.0)# ip filter all_out 100
    3. インターフェースを有効化する
      1. Router(config-MobileEthernet0.0)# no shutdown
      無効化時は、shutdownと入力する。
    4. インターフェースの指定を解除する
      1. Router(config-MobileEthernet0.0)# exit
      2. Router(config)#
  6. ネットワーク経由でログインできるようにする
    7. sshでネットワーク上のPCからルータにログインできるように設定する
    1. sshサーバーの有効化
      1. Router(config)# ssh-server ip enable
    2. 接続元を制限する
      1. Router(config)# ssh-server ip permit 192.168.1.0/24
      セキュリティ対策のため、接続できるIPアドレスを制限する。(例では、192.168.1.XXからのみ接続可能)
  7. 設定を保存する
    1. Router(config)# write memory
    機種によっては、saveを使用する。 
    1. Router(config)# save
    設定を保存しないと、再起動時に現在の設定は失われる。
  8. オペレーションモードに戻る(コンフィグモードを終了する)
    1. Router(config)# exit
    2. Router#

備考

  • 何も入力がない状態でのタブ補完で、コマンド一覧が表示できる
  • タブ補完で、コマンドやヘルプが表示できる

まとめ

  • NECルータの設定方法ついて調査、記載した

参考文献


変更履歴

  1. 2020/05/16: 新規作成
時刻: 0 件のコメント:
ラベル: ,

2020/05/13

RLoginでデータ転送

背景

Windows環境からSSHでログインしたLinuxに、データを転送する方法を調査した。

記事の目的

RLoginでSSHログインLinuxとデータ転送をできるようにする

RLoginとは

RLoginは、Culti (kmiya@culti) が開発しているWindows用のターミナルソフトである。
タブ単位で操作でき、様々なショートカットキーを登録できることが特色である。


RLoginの導入方法

RLoginの設定方法を参照

RLoginでデータ転送する方法

ここでは、RLoginでデータ転送する方法について記載する。
  1. SSHでログインし、転送ボタンを押す
    • ログイン方法は、RLoginの設定方法を参照
    • 転送ボタンは、画面上にあるバー内の、左から6つめのアイコン
  2. 転送するファイルの存在するディレクトリと転送先のディレクトリに移動する
    • 画面内、左半分
      • 接続元(Windows)PCのエクスプローラー画面
    • 画面内、右半分
      • 接続先(Linux)PCのエクスプローラー画面
  3. 接続先にアップロード
    4. アップロードしたいファイルを右クリックし、ファイルのアップロード(U)を選択する。接続先(Linux)PCの、現在表示しているディレクトリに転送される。
  4. 接続先からダウンロード
    5. ダウンロードしたいファイルを右クリックし、ファイルのダウンロード(D)を選択する。接続元(Windows)PCの、現在表示しているディレクトリに転送される。

まとめ

  • RLoginでファイル転送する方法ついて調査、記載した

参考文献


変更履歴

  1. 2020/05/13: 新規作成
時刻: 0 件のコメント:
ラベル: ,

2020/05/10

python-socketioでAttributeError: 'module' object has no attribute 'main_thread'が出る場合の対処法

背景

Python2.7でpython-socketioを使用したとき時、下記のエラーが発生した。
  1. $ python ./test_socketio_client.py 
  2. Traceback (most recent call last):
  3.   File "./test_socketio_client.py", line 123, in 
  4.     sio_client = SocketIOClient('127.0.0.1', 10000, 'test', 'secret')
  5.   File "./test_socketio_client.py", line 76, in __init__
  6.     self.sio_        = socketio.Client()
  7.   File "/home/emptyset/.local/lib/python2.7/site-packages/socketio/client.py", line 88, in __init__
  8.     threading.current_thread() == threading.main_thread():
  9. AttributeError: 'module' object has no attribute 'main_thread'

記事の目的

python-socketioのAttributeErrorを解決する

原因と対策

エラー原因

threadingモジュールのバージョン問題である。threadingの説明によると、main_thread関数は、バージョン 3.4以降で追加されたメソッドであるため、Python2系では使用できない。

対策

該当モジュールのmain_thread関数を修正する。
  1. python-socketioの該当モジュール(例/home/emptyset/.local/lib/python2.7/site-packages/socketio/client.py)を修正する
    2. 修正前 
    1.         global original_signal_handler
    2.         if original_signal_handler is None and \
    3.                 threading.current_thread() == threading.main_thread():
    4.             original_signal_handler = signal.signal(signal.SIGINT,
    5.                                                     signal_handler)
    修正後 
    1.         global original_signal_handler
    2.         if original_signal_handler is None and\
    3.                 threading.current_thread().isDaemon() is False:
    4.             original_signal_handler = signal.signal(signal.SIGINT,
    5.                                                     signal_handler)
    Clientのインスタンス生成がmainスレッドでのみ可能になってるが、この部分を削除した。代わりに、スレッドがデーモンかの判定を追加した。(mainスレッド以外がデーモンであると仮定)
  2. python-engineioの該当モジュール(例/home/emptyset/.local/lib/python2.7/site-packages/engineio/client.py)を修正する
    3. 修正前 
    1.         global original_signal_handler
    2.         if original_signal_handler is None and \
    3.                 threading.current_thread() == threading.main_thread():
    4.             original_signal_handler = signal.signal(signal.SIGINT,
    5.                                                     signal_handler)
    修正後 
    1.         global original_signal_handler
    2.         if original_signal_handler is None and \
    3.                 threading.current_thread().isDaemon() is False:
    4.             original_signal_handler = signal.signal(signal.SIGINT,
    5.                                                     signal_handler)
    Clientのインスタンス生成がmainスレッドでのみ可能になってるが、この部分を削除した。代わりに、スレッドがデーモンかの判定を追加した。(mainスレッド以外がデーモンであると仮定)
  3. 動作確認を行う
    1. $ python ./test_socketio_client.py 
    2. Try to connect to server(localhost:10000, namespace="/test", query="secret")
    3. Namespace may be invalid.(namespace="/test")
    4. Connected to server (localhost:10000, namespace="/test", query="secret")
    5. Send message {'test_data': 'send_from_client'} (namespace="/test")
    6. Emit message {'test_data': 'emit_from_client'} (namespace="/test")
    7. Received message {u'test_ack': u'send_from_server'}
    8. Received message {u'test_ack': u'emit_from_server'}
    9. ...

まとめ

  • python-socketioでAttributeError: 'module' object has no attribute 'main_thread'が出る場合の対処法について調査、記載した

参考文献


変更履歴

  1. 2020/05/10: 新規作成
時刻: 0 件のコメント:
ラベル: ,

RLoginで多段ssh

背景

Windows環境から別ネットワーク内のLinuxにSSHでログインするための方法を調査した。

記事の目的

RLoginでWindowsから多段SSHできるようにする

多段SSHとは

多段SSHは、別ネットワークと自分のPCがあるネットワークの両方に接続されたPC(踏み台サーバー)を経由して、別ネットワーク内のPCにSSHログインする方法である。
踏み台サーバーにポートフォワード設定を行ってプロキシサーバーとし、自分のPCから踏み台サーバー経由で接続する。

RLoginの導入方法

RLoginの設定方法を参照

RLoginの設定方法

ここでは、RLoginで多段SSHを行うための設定方法について記載する。

1. 踏み台サーバーの設定方法

  1. Server Selectウインドウの新規(N)をクリック(Server Selectウインドウは、RLoginウインドウ右上の黄色いプラグマークで表示できる)
  2. 接続設定を行う
    1. エントリー名
      2. この接続設定の名前を記入する
    2. コメント
      3. この接続設定の説明を記入する
    3. タブ
      4. 接続先のタグを記載する(Server Selectウインドウ内で、タブ毎に整理されて表示されるようになる)
    4. 前接続先
      5. 記載しない
    5. ホスト名(サーバーIPアドレス)
      6. 踏み台サーバーのホスト名、又はIPアドレスを記入する
    6. TCPポート
      7. SSHの場合は、sshとする
    7. ログインユーザー名
      8. 踏み台サーバーのログインするユーザー名を記入する
    8. ユーザー認証の方式によりパスワードorパスフレーズ
      9. パスワード認証の場合、踏み台サーバーのパスワードを入力する
    9. SSH認証鍵
      10. RSA認証の場合、ここをクリックして踏み台サーバーの認証鍵を指定する
    10. プロキシ設定
      11. 社内ネットワークなど、プロキシ経由でアクセスする場合はここを設定する
  3. ポートフォワード設定
    1. プロトコル内のポートフォワードを選択
    2. 新規(N)を選択
    3. ポートフォワード設定
      1. Listened
        2. Local Socksを選択する
      2. Hostname
        3. localhostと記載する
      3. Port
        4. ポートフォワードで使用するポート番号を記載する(ここでは、9000とした)
      4. OKボタンを押す
  4. 全てのウインドウをOKで閉じる

2. 接続先の設定方法

  1. Server Selectウインドウの新規(N)をクリック(Server Selectウインドウは、RLoginウインドウ右上の黄色いプラグマークで表示できる)
  2. 接続設定を行う
    1. エントリー名
      2. この接続設定の名前を記入する
    2. コメント
      3. この接続設定の説明を記入する
    3. タブ
      4. 接続先のタグを記載する(Server Selectウインドウ内で、タブ毎に整理されて表示されるようになる)
    4. 前接続先
      5. 踏み台サーバー(例では、Linux PC 1)を記載する
    5. ホスト名(サーバーIPアドレス)
      6. 接続先のホスト名、又はIPアドレスを記入する
    6. TCPポート
      7. SSHの場合は、sshとする
    7. ログインユーザー名
      8. 接続先のログインするユーザー名を記入する
    8. ユーザー認証の方式によりパスワードorパスフレーズ
      9. パスワード認証の場合、接続先のパスワードを入力する
    9. SSH認証鍵
      10. RSA認証の場合、ここをクリックして接続先の認証鍵を指定する
  3. プロキシ設定
    1. Server Edit Entryウインドウ内におけるサーバーのプロキシ設定(P)を選択する
    2. Select Proxy Protocol
      3. SOCKS5を選択
    3. Over SSL
      4. 使用しないを選択
    4. Proxy Server Address
      5. localhostと記載
    5. Socket Port
      6. 踏み台サーバーのポートフォワードで使用しているポート番号を記載する(例では9000)
  4. 全てのウインドウをOKで閉じる

多段SSHの使用方法

ここでは、RLoginで多段SSHの方法について記載する。
  1. Server Selectウインドウで接続先を選択し、OKボタンを押す
  2. 踏み台サーバーと接続先の両方へSSHでログインされる

備考

  • 踏み台サーバーとの接続を切断すると、接続先も切断される


まとめ

  • RLoginで多段SSHする方法ついて調査、記載した

参考文献


変更履歴

  1. 2020/05/10: 新規作成
時刻: 0 件のコメント:
ラベル: ,

2020/05/07

Dockerコンテナ内でnpm installをした場合のエラー(EAI_AGAIN)に対する対処法(Linux編)

背景

プロキシ下のPC上でDockerを使用し、コンテナ上でnpm installを行った時、下記のエラーが発生した。
  1. $ npm install
  2. npm ERR! code EAI_AGAIN
  3. npm ERR! errno  EAI_AGAIN

記事の目的

DockerにDNSアドレスを設定し、コンテナ内でホスト名を解決できるようにする

原因と対策

エラー原因

DockerがDNSを見つけられないため、コンテナ内でホスト名をIPアドレスに変換できない。
社内プロキシ内などプロキシ下のPCである場合、プロキシサーバーのホスト名を解決できない。

対策

DockerにDNSのアドレスを登録する。
  1. /etc/docker/daemon.jsonを作成する
    1. {
    2.     "dns": ["DNSアドレス1","DNSアドレス2"]
    3. }
    DNSアドレスは、8.8.8.8(GoogleのDNS)や社内ネットワーク内のDNSアドレスを設定する。
  2. dockerを再起動する
    1. $ sudo ststemctl docker restart

まとめ

  • Dockerコンテナ内でnpm installを行った際、EAI_AGAINと表示されインストールできない問題を修正する方法について調査、記載した

参考文献


変更履歴

  1. 2020/05/07: 新規作成
時刻: 0 件のコメント:
ラベル: ,

RLoginでシリアルコンソール接続

背景

Windows10環境からルーターなどのネットワーク機器にコンソールでログインする必要があったため、調査した。

記事の目的

RLoginでシリアルコンソールに接続できるようにする

RLoginとは

RLoginは、Culti (kmiya@culti) が開発しているWindows用のターミナルソフトである。
タブ単位で操作でき、様々なショートカットキーを登録できることが特色である。

RLoginの導入方法

RLoginの設定方法を参照

シリアルコンソールへの接続

ここでは、シリアルコンソールに接続するための方法について記載する。
  1. 機器との接続
    2. コンソールケーブルを使用し、機器と接続する
  2. デバイスマネージャーを開く
    3. 画面左下のWindowsマークを右クリックし、デバイスマネージャーを選択する
  3. COMポート番号を確認
    4. ポート番号を確認する(複数ある場合、機器を抜き差しして確認(操作(A)→ハードウェア変更のスキャン(A)で表示の更新も行う))

RLoginの設定方法

ここでは、RLoginでシリアルコンソールに接続するための設定方法について記載する。
  1. Server Selectウインドウの新規(N)をクリック(Server Selectウインドウは、RLoginウインドウ右上の黄色いプラグマークで表示できる)
  2. 接続設定を行う
    1. エントリー名
      2. この接続設定の名前を記入する
    2. コメント
      3. この接続設定の説明を記入する
    3. プロトコル
      4. comを選択する
    4. タブ
      5. 接続先のタグを記載する(Server Selectウインドウ内で、タブ毎に整理されて表示されるようになる)
    5. ホスト名(サーバーIPアドレス)
      6. ビットレート;データビット;パリティ(NOP,ODD,EDEN,MARK,SPC);ストップビット;フロー制御(NOC,CTS,XON);を記入する(例: 9600;8;NOP;1;NOC;)
    6. TCPポート
      7. シリアルコンソールの場合は、COMポートを指定する(自分のPCの場合、COM1が全面にあるUSB3.0ポートだった)
    7. OKボタンを押す
  3. Server Selectウインドウで接続先の設定を選択(クリック)し、OKボタンを押す

備考

  • 上記設定(9600;8;NOP;1;NOC;)でNECのルータに接続できることは確認済み

まとめ

  • RLoginでシリアルコンソール接続する方法ついて調査、記載した

参考文献


変更履歴

  1. 2020/05/07: 新規作成
時刻: 0 件のコメント:
ラベル: ,

2020/05/06

PlantUMLでユースケース図作成

背景

システムの要件定義でユースケース図を作成する必要があり、Gitで差分管理が可能なユースケース図作成ツールを調査した。

記事の目的

PlantUMLでユースケース図を作成する

ユースケース図

ユースケース図について記載する。

ユースケース図とは

ユースケース図は、ユーザ（外部システムも含む）の要求に対するシステムの振る舞いを記述したものである。

ユースケース図の描き方

  • 利用者（Actor）
    1. @startuml
    2. actor :Actor:
    3. @enduml
    システムの利用者を表す。
  • ユースケース（Usecase）
    1. @startuml
    2. usecase Usecase
    3. @enduml
    システムの利用シーン(ユースケース)を表す。
  • サブジェクト（Subject）
    1. @startuml
    2. rectangle Subject {
    3.     usecase Usecase1
    4.     usecase Usecase2
    5. }
    6. @enduml
    システムの境界線を表す。
  • パッケージ（Package）
    1. @startuml
    2. rectangle Subject {
    3.     package Package1 {
    4.         usecase Usecase1
    5.         usecase Usecase2
    6.     }
    7.     package Package2 {
    8.         usecase Usecase3
    9.         usecase Usecase4
    10.     }
    11. }
    12. @enduml
    サブジェクト内で複数のユースケースをまとめて表現する。
  • オブジェクト間の関係
    1. @startuml
    2. actor :Member:
    3. actor :Customer:
    4. actor :Employee:
    6. rectangle "Shopping system" {
    7.     package "Customer registration" {
    8.         usecase "ID registration" as id
    9.         usecase "Name registration" as name
    10.         usecase "Shopping list registration" as asmt
    11.         usecase "Password registration" as pw
    12.         /'Include: <., .>, <.., or ..>'/
    13.         id <.. name : <<include>>
    14.         /'Extend: <., .>, <.., or ..>'/
    15.         id ..> asmt : <<extend>>
    16.     }
    17.     package "Customer  search" {
    18.         usecase "Search customer  by name" as se
    19.         usecase "Show list of all customer " as sh
    20.     }
    21. }
    22. /'Generalization: <|-, -|>, <|--, or --|>'/
    23. Member --|>  Employee
    25. /'Relationship: --, or -'/
    26. Customer  -- id
    27. Customer  -- pw
    29. se -- Employee
    30. sh -- Employee
    31. @enduml
    • 関連（Relationship）
      • アクターとユースケースをつなげるときに使用する。
    • 汎化（Generalization）
      • オブジェクト間で「汎化関係」が成り立つときに使用する。汎化関係とは、「担当社員」と「XX社社員」のように要素と要素の所属の関係である。
    • 包含（Include）
      • オブジェクト間で「包含関係」が成り立つときに使用する。包含関係とは、「個人情報登録」と「住所登録」のように全体と構成要素の関係である。
    • 拡張（Extend）
      • 拡張するユースケース（機能）を表現する際に使用する。包含の逆である。

作成時の注意点

ユースケース図作成時の注意点について記載する。
  • 網羅的に書く
    • 利用者やユースケースは省略せずにすべて書く。
  • 利用者視点で書く
    • ユースケース図は、開発者ではなく、システム利用者視点で書く。
  • シンプルに書く
    • 分岐条件やシステム内部のロジックなどは書かない。
  • 機能分割しない
    • ユースケースを詳細な機能に分割しない。
  • ユースケースの粒度を統一する
    • ユースケースの粒度(抽象度)を均一にする。
  • 表現を統一する
    • 同じ意味の内容は、同じ表現で記載する。
  • ユースケース記述も一緒に作成する
    • ユースケース名、概要、利用者、事前条件、トリガー、処理フローについての資料も別途作成しておく。

まとめ

  • PlantUMLでユースケース図を作成する方法を調査、記載した


参考文献


変更履歴

  1. 2020/05/06: 新規作成
時刻: 0 件のコメント:
ラベル: ,

PlantUMLで配置図作成

背景

システムの全体設計で配置図を作成する必要があり、Gitで差分管理が可能な配置図作成ツールを調査した。

記事の目的

PlantUMLで配置図を作成する

配置図

配置図について記載する。

配置図とは

配置図は、システムの物理的側面（ハードウェア構成や通信経路等）を記述したものである。

配置図の描き方

  • 要素
    1. @startuml
    2. actor Actor
    3. card Card
    4. cloud Cloud
    5. component Component
    6. database Database
    7. file File
    8. folder Folder
    9. frame Frame
    10. interface Interface
    11. node Node
    12. package Package
    13. storage Strage
    14. @enduml
    システムの構成要素を表す。
    • 利用者（Actor）
      利用者を表す。
    • カード（Card）
      認証カードや社員証などのカードを表す。
    • クラウド（Cloud）
      AWSやAzureなどのクラウドサービスを表す。
    • コンポーネント（Component）
      クラスやオブジェクトなどのソフトウェアの最小単位
    • データベース（Database）
      SQLやMongoなどのデータベースを表す。
    • ファイル（File）
      データの最小単位。
    • フォルダ（Folder）
      ファイルをまとめた構造体を表す。
    • フレーム（Frame）
      特定の構造、規則に基づいて作成されたソフトウェア群を表す。
    • インターフェース（Interface）
      ネットワークインターフェースなど、複数要素の接続点を表す。
    • ノード（Node）
      PCなどのハードウェアの最小単位
    • パッケージ（Package）
      特定の目的のために作成されたソフトウェア群を表す。
    • ストレージ（Strage）
      NAS、blob-strageなどの記憶媒体を表す。
  • 入れ子表現
    1. @startuml
    2. node "Controle PC" {
    3.     frame "ROS" {
    4.         component "Controle node"
    5.     }
    6. }
    7. @enduml
    システムの親子関係を表すことができる。
  • 接続
    1. @startuml
    2. node "Control PC" as p{
    3.     frame "ROS" {
    4.         component "Control node" as c
    5.         component "Communication node" as com
    6.         component "rviz" as r
    7.     }
    8.     interface "/dev/usb_ctr" as i1
    9.     interface "Full size HDMI" as i2
    10.     interface "LTE dongle" as i3
    11. }
    12. node "Robot arm" as a
    13. node "Monitor" as m
    14. cloud "Cloud vpn network" {
    15.     interface "10.0.0.2" as n1
    16. }
    17. /'ROS network'/
    18. com --> c
    19. c   --> r
    21. /'Control network'/
    22. c  ->  i1
    23. i1 --> a: USB
    25. /'Monitor network'/
    26. r  -left-> i2
    27. i2 -down-> m: HDMI
    29. /'Communication network'/
    30. com <-left-> i3
    31. i3  <-up->   n1: LTE
    32. @enduml
    システムの接続関係を表すことができる。矢印はデータの流れる向きを表す。ノードの中身を抽象化し、省略する場合もある。

まとめ

  • PlantUMLでコンポーネント図を作成する方法を調査、記載した

参考文献

変更履歴

  1. 2020/05/06: 新規作成
時刻: 0 件のコメント:
ラベル: ,

PlantUMLでシーケンス図作成

背景

システムの詳細設計でシーケンス図を作成する必要があり、Gitで差分管理が可能なクラス図作成ツールを調査した。

記事の目的

PlantUMLでシーケンス図を作成する

シーケンス図

シーケンス図について記載する。

シーケンス図とは

シーケンス図は、クラスやオブジェクト間のやりとりを時間軸に沿って表現したものである。

シーケンス図の描き方

  • ライフライン（Lifeline）
    1. @startuml
    2. participant Participant
    3. actor Actor
    4. database Database
    5. collections Collections
    6. @enduml
    使用するオブジェクトやクラスを表す。利用者(Actor)、オブジェクトやクラス(Participant)、データベース(Database)、集合(Collections)がある。
  • 実行仕様（ExecutionSpecification）
    1. @startuml
    2. participant Participant
    3. Participant -> Participant: Activate
    4. activate Participant
    5. Participant -> Participant: Deactivate
    6. deactivate Participant
    7. @enduml
    生成されているライフラインが実行状態であることを表す。
  • 停止（Stop）
    1. @startuml
    2. participant Participant
    3. activate Participant
    4. Participant -> Participant: Destroy
    5. destroy Participant
    6. @enduml
    生成されたライフライン自体の消滅を表す。
  • メッセージ（Message）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. c -> s : Synchronous message
    6. activate s
    7. s --> c: Reply message
    8. c ->> s: Asynchronous message
    9. [o->  s: Found message
    10. c ->o] : Lost message
    11. @enduml
    データやトリガーの通信を表す。
    • 同期（Synchronous）メッセージ
      • 送り先のライフラインの実行に同期されるメッセージを表す。
    • 非同期（Asynchronous）メッセージ
      • 送り先のライフラインの実行に同期されないメッセージを表す。
    • 応答（Reply）メッセージ
      • 送り先のライフラインから送り手への戻り値を表す。
    • ファウンド（Found）メッセージ
      • 図解上にない送り手から送られた、もしくは送り手がダイアグラム上にないことを表す。
    • ロスト（Lost）メッセージ
      • 意図された受け手に送られていない、もしくは受け手がダイアグラム上にないことを表す。
  • 参照（Reference）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. c -> s : Connect
    6. activate s
    7. c -> s : Login
    8. ref over s
    9.     Check id and password
    10.     sequence
    11. end ref
    12. s --> c: Result
    13. @enduml
    別で定義されてるシーケンス図を参照することを表す。
  • 条件分岐（Alternative）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. c -> s : Connect
    6. activate s
    7. c -> s : Login
    8. s -> s : Check ID and password
    9. alt ID and password are matched
    10.     s --> c: Send token
    11. else not matched
    12.     s --> c: Disconnect
    13. else ID is not exist
    14.     s --> c: Disconnect
    15. end
    16. @enduml
    条件による処理の分岐を表す。
  • 条件判断（Option）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. c -> s : Connect
    6. activate s
    7. c -> s : Login
    8. s -> s : Check ID and password
    9. opt ID and password are matched
    10.     s --> c: Send an authorized token
    11. end
    12. @enduml
    条件を満たす場合に処理を実行することを表す。
  • 並列処理（Parallel）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. database    "Login record DB" as db
    5. activate c
    6. c -> s : Connect
    7. activate s
    8. c -> s : Login
    9. s -> s : Check ID and password
    10. opt ID and password are matched
    11.     par
    12.         s -> s : Create an authorized token
    13.         s --> c: Send an authorized token
    14.     else
    15.         s -> db: Send login time
    16.         activate db
    17.         db -> db: Record login time
    18.         deactivate db
    19.     end
    20. end
    21. @enduml
    複数の処理を並列で実行することを表す。
  • 反復処理（Loop）
    1. @startuml
    2. collections Client as c
    3. participant Server as s
    4. activate c
    5. activate s
    6. opt Time is 00:00
    7.     loop Number of connected clients
    8.         s -> c : Check client status
    9.         c --> s: Send status
    10.     end
    11. end
    12. @enduml
    処理を反復実行することを表す。
  • 中断（Break）
    1. @startuml
    2. collections Client as c
    3. participant Server as s
    4. activate c
    5. activate s
    6. opt Time is 00:00
    7.     loop Number of connected clients
    8.         s -> c : Check client status
    9.         c --> s: Send status
    10.         break Client status is illegal
    11.             loop Number of connected clients
    12.                 s -> c : Disconnect
    13.             end
    14.         end
    15.     end
    16. end
    17. @enduml
    反復処理中に特定の条件を満たした場合、(決められた処理を行い)反復処理を中止することを表す。
  • クリティカルセッション（Critical）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. database    "Login record DB" as db
    5. activate c
    6. c -> s : Connect
    7. activate s
    8. c -> s : Login
    9. s -> s : Check ID and password
    10. opt ID and password are matched
    11.     par
    12.         s -> s : Create an authorized token
    13.         s --> c: Send an authorized token
    14.         s -> db: Send an authorized token
    15.         critical
    16.             activate db
    17.             db -> db: Record an authorized token
    18.             deactivate db
    19.         end
    20.     else
    21.         s -> db: Send login time
    22.         critical
    23.             activate db
    24.             db -> db: Record login time
    25.             deactivate db
    26.         end
    27.     end
    28. end
    29. @enduml
    並列処理中に、排他制御された処理を表す。
  • アサート（Assert）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. database    "Deposit record DB" as db
    5. activate c
    6. activate s
    7. c -> s : Send transfer information
    8. group assert 
    9. s -> db: Update deposit amount
    10. note right : Deposit amount = Transfer amount + Previous deposit amount
    11. activate db
    12. db -> db: Record deposit amount
    13. deactivate db
    14. end
    15. @enduml
    処理結果の妥当性を保証しなければならないことを表す。
  • 不正なシーケンス（Negative）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. database    "Deposit record DB" as db
    5. activate c
    6. activate s
    7. c -> s : Send transfer information
    8. alt Deposit amount = Transfer amount + Previous deposit amount 
    9.     s -> db: Update deposit amount
    10.     activate db
    11.     db ->db: Record deposit amount
    12.     s --> c: Send accept msg
    13.     deactivate db
    14. else Deposit amount != Transfer amount + Previous deposit amount 
    15.     group neg
    16.         s -->c : Send error msg
    17.     end
    18. end
    19. @enduml
    処理が通常起こりえない処理である(異常系である)ことを表す。
  • 無効（Ignore）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. c -> s : Connect
    6. activate s
    7. group ignore {Send client status}
    8. c -> s : Login(Send id, password)
    9. c -> s : Send client status
    10. end
    11. s -> s : Check ID and password
    12. alt ID and password are matched
    13.     s --> c: Send token
    14. else not matched
    15.     s --> c: Disconnect
    16. end
    17. @enduml
    必須ではない処理を{}内に記載する。
  • 有効（Consider）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. c -> s : Connect
    6. activate s
    7. group consider {Login(Send id, password)}
    8. c -> s : Login(Send id, password)
    9. c -> s : Send client status
    10. end
    11. s -> s : Check ID and password
    12. alt ID and password are matched
    13.     s --> c: Send token
    14. else not matched
    15.     s --> c: Disconnect
    16. end
    17. @enduml
    必須な処理を{}内に記載する。
  • セクション（Section）
    1. @startuml
    2. participant Client as c
    3. participant Server as s
    4. activate c
    5. == Make connection ==
    6. c -> s : Connect
    7. activate s
    8. == Login ==
    9. c -> s : Login
    10. ref over s
    11.     Check id and password
    12.     sequence
    13. end ref
    14. s --> c: Result
    15. @enduml
    セクションで区切ると、処理をまとめて整理できる。
  • オブジェクト生成（Create）
    1. @startuml
    2. participant parent as p
    3. activate p
    4. p -> p: Initial process
    5. create participant child as c
    6. p -> c: New
    7. @enduml
    オブジェクト(インスタンス)を生成していることを表す。

まとめ

  • PlantUMLでシーケンス図を作成する方法を調査、記載した

参考文献


変更履歴

  1. 2020/05/06: 新規作成
時刻: 0 件のコメント:
ラベル: ,

2020/05/04

Rloginの設定方法

背景

Windows環境からLinuxにSSHでログインするための方法を調査した。
TeraTerm、putty、Poderosaなどが有名所だが、タブ表示ができる等、操作性が良いためRLoginを採用した。

記事の目的

RLoginでWindowsからLinuxにログインできるようにする

RLoginとは

RLoginは、Culti (kmiya@culti) が開発しているWindows用のターミナルソフトである。
タブ単位で操作でき、様々なショートカットキーを登録できることが特色である。

RLoginの導入方法

ここでは、RLoginの導入方法について記載する。
  1. GitHubからバイナリファイルのzipファイル(rlogin_x64.zipなど)をダウンロードする
  2. zipファイルを解凍する
  3. 解凍したフォルダの中のRLogin.exeを実行する

RLoginの設定方法

ここでは、RLoginでSSHを行うための設定方法について記載する。
  1. Server Selectウインドウの新規(N)をクリック(Server Selectウインドウは、RLoginウインドウ右上の黄色いプラグマークで表示できる)
  2. 接続設定を行う
    1. エントリー名
      2. この接続設定の名前を記入する
    2. コメント
      3. この接続設定の説明を記入する
    3. タブ
      4. 接続先のタグを記載する(Server Selectウインドウ内で、タブ毎に整理されて表示されるようになる)
    4. 前接続先
      5. 多段SSHを行う際に、この接続の踏み台サーバーを記載する
    5. プロトコル
      6. SSHの場合は、sshを選択する
    6. ホスト名(サーバーIPアドレス)
      7. ホスト名、又はIPアドレスを記入する
    7. TCPポート
      8. SSHの場合は、sshとする
    8. ログインユーザー名
      9. ログインするユーザー名を記入する
    9. ユーザー認証の方式によりパスワードorパスフレーズ
      10. パスワード認証の場合、パスワードを入力する
    10. SSH認証鍵
      11. RSA認証の場合、ここをクリックして認証鍵を指定する
    11. プロキシ設定
      12. 社内ネットワークなど、プロキシ経由でアクセスする場合はここを設定する
    12. OKボタンを押す
  3. Server Selectウインドウで接続先のサーバーを選択(クリック)し、OKボタンを押す

まとめ

  • RLoginの設定方法ついて調査、記載した

参考文献


変更履歴

  1. 2020/05/04: 新規作成
時刻: 0 件のコメント:
ラベル: ,

2020/05/03

PlantUMLでアクティビティ図作成

背景

システムの詳細設計でアクティビティ図を作成する必要があり、Gitで差分管理が可能なクラス図作成ツールを調査した。

記事の目的

PlantUMLでアクティビティ図を作成する

アクティビティ図

アクティビティ図について記載する。

アクティビティ図とは

アクティビティ図は、ある事象の開始から終了までの機能を実行される順序にしたがって記述したものである。

アクティビティ図の描き方

  • 初期ノードと最終ノード
    1. @startuml
    2. start
    3. end
    4. @enduml
    スコープ内の開始と終了を表す。
  • アクションノード
    1. @startuml
    2. start
    3. : Action;
    4. end
    5. @enduml
    制御を表す。
  • デシジョンノードとマージノード
    1. @startuml
    2. start
    3. if (i == 0 || i ==3) then (true)
    4.     :Fizz Buzz;
    5.     : i++;
    6. else if (i == 1) then (true)
    7.     :Fizz;
    8.     : i++;
    9. else if (i == 2) then (true)
    10.     :Buzz;
    11.     : i++;
    12.  else (false)
    13.     : i++;
    14. endif
    15. end
    16. @enduml
    条件によるフロー分岐（デシジョンノード）もしくは、複数のフローの合流（マージノード）を表す。
  • フォークノードとジョインノード
    1. @startuml
    2. start
    3. fork
    4.     : Process A;
    5. fork again
    6.     : Process B;
    7.     : Process C;
    8. endfork
    9. end
    10. @enduml
    複数のフローが非同期に実行される（フォークノード）、もしくは、複数の非同期処理が終了する（ジョインノード）ことを表す。
  • 最終制御
    1. @startuml
    2. start
    3. if (command == exit) then (true)
    4.     stop
    5. endif
    6. end
    7. @enduml
    それまでの制御で使用されたトークンを全て破棄することを表す。
  • オブジェクト
    1. @startuml
    2. start
    3. :Open the door>
    4. :Door(Object)]
    5. end
    6. @enduml
    制御のターゲットとなるオブジェクトを表す。
  • パーティション
    1. @startuml
    2. start
    3. partition Client {
    4.     :Select;
    5. }
    6. partition Server {
    7.     if (Type) then (A)  
    8.         :Process A;
    9.     else (B)
    10.         :Process B;
    11.     endif
    12. }
    13. end
    14. @enduml
    1. @startuml
    2. |Client|
    3. start
    4. :Select;
    5. if (Type) then (A)
    6.     |Server|
    7.     :Process A;
    8. else (B)
    9.     |Server|
    10.     :Process B;
    11. endif
    12. end
    13. @enduml
    制御がどの領域に属するかを表すための領域分けとして使用される。
  • 送信とアクション
    1. @startuml
    2. start
    3. : Emit >
    4. end
    5. @enduml
    オブジェクトにシグナルを送信する制御を表す。
  • 受信
    1. @startuml
    2. |Client|
    3. start
    4. : Emit>
    5. |Server|
    6. : Receive<
    7. end
    8. @enduml
    シグナル、またはイベントの発生の待機を表す。
  • 繰り返し
    1. @startuml
    2. start
    3. :i=0;
    4. while (i<10) is (true)
    5.   :i++;
    6. endwhile (false)
    7. end
    8. @enduml
    1. @startuml
    2. start
    3. :i=0;
    4. repeat :Process A;
    5.     :Process B;
    6. backward:i++;
    7. repeat while (i<10) is (true)
    8. end
    9. @enduml
    繰り返し処理を表す。

まとめ

  • PlantUMLでアクティビティ図を作成する方法を調査、記載した

参考文献


変更履歴

  1. 2020/05/03: 新規作成
時刻: 0 件のコメント:
ラベル: ,
登録: 投稿 (Atom)

MQTTの導入

背景 IoTデバイスの接続環境構築のため、MQTT(mosquitto)の導入を行った。 記事の目的 MQTT(mosquitto)をUbuntuに導入する mosquitto ここではmosquittoについて記載する。 MQTT MQTT(Message Qu...