Update setup.py

add readme.txt to release for standalone zip files

.github/workflows/build_executables.yml

@@ -1,90 +0,0 @@
-name: Build and publish standalone executables
-
-on: workflow_dispatch
-
-jobs:
-
-  build-and-publish-mac:
-    runs-on: macos-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-
-      - name: Setup code signing
-        env:
-          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
-          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
-          MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
-        run: |
-          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
-          security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-          security default-keychain -s meshtastic.keychain
-          security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-          security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
-          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
-
-      - name: Build
-        env:
-          MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
-        run: |
-          pip install pyinstaller
-          pip install -r requirements.txt
-          pip install .
-          pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
-      - uses: actions/upload-artifact@v2
-        with:
-          name: meshtastic_mac
-          path: dist
-
-  build-and-publish-ubuntu:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-
-      - name: Build
-        run: |
-          pip install pyinstaller
-          pip install -r requirements.txt
-          pip install .
-          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
-      - uses: actions/upload-artifact@v2
-        with:
-          name: meshtastic_ubuntu
-          path: dist
-
-
-  build-and-publish-windows:
-    runs-on: windows-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-
-      - name: Build
-        run: |
-          pip install pyinstaller
-          pip install -r requirements.txt
-          pip install .
-          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
-      - uses: actions/upload-artifact@v2
-        with:
-          name: meshtastic_windows
-          path: dist

.github/workflows/publish_to_pypi.yml

@@ -1,35 +0,0 @@
-name: Publish PyPI
-
-on: workflow_dispatch
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Install pypa/build
-        run: >-
-          python -m
-          pip install
-          build
-          --user
-      - name: Build a binary wheel and a source tarball
-        run: >-
-          python -m
-          build
-          --sdist
-          --wheel
-          --outdir dist/
-          .
-      - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          username: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,179 @@
+name: Make Release
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Release version (Example: 1.0.0, must match 'version' in setup.py)"
+        required: true
+        default: '1.0.0'
+
+jobs:
+  release_create:
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - name: Create GitHub release
+      uses: actions/create-release@v1
+      id: create_release
+      with:
+        draft: true
+        prerelease: true
+        release_name: ${{ github.event.inputs.version}}
+        tag_name: ${{ github.event.inputs.version}}
+        body: |
+          Autogenerated by github action, developer should edit as required before publishing...
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    outputs:
+      upload_url: ${{ steps.create_release.outputs.upload_url }}
+
+  publish_to_pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+          .
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+
+  build-and-publish-mac:
+    runs-on: macos-latest
+    needs: release_create
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Setup code signing
+        env:
+          MACOS_CERTIFICATE: ${{ secrets.MACOS_CERTIFICATE }}
+          MACOS_CERTIFICATE_PWD: ${{ secrets.MACOS_CERTIFICATE_PWD }}
+          MACOS_KEYCHAIN_PASSWORD: ${{ secrets.MACOS_KEYCHAIN_PASSWORD }}
+        run: |
+          echo $MACOS_CERTIFICATE | base64 --decode > certificate.p12
+          security create-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+          security default-keychain -s meshtastic.keychain
+          security unlock-keychain -p "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+          security import certificate.p12 -k meshtastic.keychain -P "$MACOS_CERTIFICATE_PWD" -T /usr/bin/codesign
+          security set-key-partition-list -S apple-tool:,apple:,codesign: -s -k "$MACOS_KEYCHAIN_PASSWORD" meshtastic.keychain
+
+      - name: Build
+        env:
+          MACOS_SIGNING_IDENTITY: ${{ secrets.MACOS_SIGNING_IDENTITY }}
+        run: |
+          pip install pyinstaller
+          pip install -r requirements.txt
+          pip install .
+          pyinstaller -F -n meshtastic --collect-all meshtastic --codesign-identity "$MACOS_SIGNING_IDENTITY" meshtastic/__main__.py
+
+      - name: Add mac to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: dist/meshtastic
+          asset_name: meshtastic_mac
+          asset_content_type: application/zip
+
+  build-and-publish-ubuntu:
+    runs-on: ubuntu-latest
+    needs: release_create
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Build
+        run: |
+          pip install pyinstaller
+          pip install -r requirements.txt
+          pip install .
+          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
+
+      - name: Add ubuntu to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: dist/meshtastic
+          asset_name: meshtastic_ubuntu
+          asset_content_type: application/zip
+          
+      - name: Add readme.txt to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: standalone_readme.txt
+          asset_name: readme.txt
+          asset_content_type: text/plain          
+
+  build-and-publish-windows:
+    runs-on: windows-latest
+    needs: release_create
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Build
+        run: |
+          pip install pyinstaller
+          pip install -r requirements.txt
+          pip install .
+          pyinstaller -F -n meshtastic --collect-all meshtastic meshtastic/__main__.py
+
+      - name: Add windows to release
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.release_create.outputs.upload_url }}
+          asset_path: dist/meshtastic.exe
+          asset_name: meshtastic_windows
+          asset_content_type: application/zip

exampleConfig.yaml

@@ -1,5 +1,6 @@
 # example config using camelCase keys
 owner: Bob TBeam
+ownerShort: BOB
 
 channelUrl: https://www.meshtastic.org/d/#CgUYAyIBAQ
 

example_config.yaml

@@ -1,5 +1,6 @@
 # example configuration file with snake_case keys
 owner: Bob TBeam
+owner_short: BOB
 
 channel_url: https://www.meshtastic.org/d/#CgUYAyIBAQ
 

meshtastic/__main__.py

@@ -195,6 +195,11 @@ def onConnected(interface):
             print(f"Setting device owner to {args.set_owner}")
             interface.getNode(args.dest).setOwner(args.set_owner)
 
+        if args.set_owner_short:
+            closeNow = True
+            print(f"Setting device owner short to {args.set_owner_short}")
+            interface.getNode(args.dest).setOwner(long_name=None, short_name=args.set_owner_short)
+
         if args.pos_fields:
             # If --pos-fields invoked with args, set position fields
             closeNow = True
@@ -332,6 +337,14 @@ def onConnected(interface):
                     print(f"Setting device owner to {configuration['owner']}")
                     interface.getNode(args.dest).setOwner(configuration['owner'])
 
+                if 'owner_short' in configuration:
+                    print(f"Setting device owner short to {configuration['owner_short']}")
+                    interface.getNode(args.dest).setOwner(long_name=None, short_owner=configuration['owner_short'])
+
+                if 'ownerShort' in configuration:
+                    print(f"Setting device owner short to {configuration['ownerShort']}")
+                    interface.getNode(args.dest).setOwner(long_name=None, short_owner=configuration['ownerShort'])
+
                 if 'channel_url' in configuration:
                     print("Setting channel url to", configuration['channel_url'])
                     interface.getNode(args.dest).setURL(configuration['channel_url'])
@@ -569,6 +582,7 @@ def subscribe():
 def export_config(interface):
     """used in--export-config"""
     owner = interface.getLongName()
+    owner_short = interface.getShortName()
     channel_url = interface.localNode.getURL()
     myinfo = interface.getMyNodeInfo()
     pos = myinfo.get('position')
@@ -583,6 +597,8 @@ def export_config(interface):
     config = "# start of Meshtastic configure yaml\n"
     if owner:
         config += f"owner: {owner}\n\n"
+    if owner_short:
+        config += f"owner_short: {owner_short}\n\n"
     if channel_url:
         if Globals.getInstance().get_camel_case():
             config += f"channelUrl: {channel_url}\n\n"
@@ -785,10 +801,12 @@ def initParser():
     parser.add_argument(
         "--ch-shortfast", help="Change to the short-range and fast channel", action='store_true')
 
-
     parser.add_argument(
         "--set-owner", help="Set device owner name", action="store")
 
+    parser.add_argument(
+        "--set-owner-short", help="Set device owner short name", action="store")
+
     parser.add_argument(
         "--set-team", help="Set team affiliation (an invalid team will list valid values)", action="store")
 

meshtastic/tests/test_main.py

@@ -425,6 +425,23 @@ def test_main_set_owner_to_bob(capsys):
         mo.assert_called()
 
 
+@pytest.mark.unit
+@pytest.mark.usefixtures("reset_globals")
+def test_main_set_owner_short_to_bob(capsys):
+    """Test --set-owner-short bob"""
+    sys.argv = ['', '--set-owner-short', 'bob']
+    Globals.getInstance().set_args(sys.argv)
+
+    iface = MagicMock(autospec=SerialInterface)
+    with patch('meshtastic.serial_interface.SerialInterface', return_value=iface) as mo:
+        main()
+        out, err = capsys.readouterr()
+        assert re.search(r'Connected to radio', out, re.MULTILINE)
+        assert re.search(r'Setting device owner short to bob', out, re.MULTILINE)
+        assert err == ''
+        mo.assert_called()
+
+
 @pytest.mark.unit
 @pytest.mark.usefixtures("reset_globals")
 def test_main_set_ham_to_KI123(capsys):
@@ -913,6 +930,7 @@ def test_main_configure_with_snake_case(capsys):
         out, err = capsys.readouterr()
         assert re.search(r'Connected to radio', out, re.MULTILINE)
         assert re.search(r'Setting device owner', out, re.MULTILINE)
+        assert re.search(r'Setting device owner short', out, re.MULTILINE)
         assert re.search(r'Setting channel url', out, re.MULTILINE)
         assert re.search(r'Fixing altitude', out, re.MULTILINE)
         assert re.search(r'Fixing latitude', out, re.MULTILINE)
@@ -940,6 +958,7 @@ def test_main_configure_with_camel_case_keys(capsys):
         out, err = capsys.readouterr()
         assert re.search(r'Connected to radio', out, re.MULTILINE)
         assert re.search(r'Setting device owner', out, re.MULTILINE)
+        assert re.search(r'Setting device owner short', out, re.MULTILINE)
         assert re.search(r'Setting channel url', out, re.MULTILINE)
         assert re.search(r'Fixing altitude', out, re.MULTILINE)
         assert re.search(r'Fixing latitude', out, re.MULTILINE)
@@ -1604,6 +1623,7 @@ def test_main_export_config(capsys):
     iface = MagicMock(autospec=SerialInterface)
     with patch('meshtastic.serial_interface.SerialInterface', return_value=iface) as mo:
         mo.getLongName.return_value = 'foo'
+        mo.getShortName.return_value = 'oof'
         mo.localNode.getURL.return_value = 'bar'
         mo.getMyNodeInfo().get.return_value = { 'latitudeI': 1100000000, 'longitudeI': 1200000000,
                                                 'altitude': 100, 'batteryLevel': 34, 'latitude': 110.0,
@@ -1620,6 +1640,7 @@ position_flags: 35"""
     assert not re.search(r'Connected to radio', out, re.MULTILINE)
 
     assert re.search(r'owner: foo', out, re.MULTILINE)
+    assert re.search(r'owner_short: oof', out, re.MULTILINE)
     assert re.search(r'channel_url: bar', out, re.MULTILINE)
     assert re.search(r'location:', out, re.MULTILINE)
     assert re.search(r'lat: 110.0', out, re.MULTILINE)

meshtastic/tests/test_node.py

@@ -55,6 +55,15 @@ def test_setOwner_and_team(caplog):
     assert re.search(r'p.set_owner.team:1', caplog.text, re.MULTILINE)
 
 
+@pytest.mark.unit
+def test_setOwnerShort(caplog):
+    """Test setOwner"""
+    anode = Node('foo', 'bar', noProto=True)
+    with caplog.at_level(logging.DEBUG):
+        anode.setOwner(long_name=None, short_name='123')
+    assert re.search(r'p.set_owner.short_name:123:', caplog.text, re.MULTILINE)
+
+
 @pytest.mark.unit
 def test_setOwner_no_short_name(caplog):
     """Test setOwner"""

setup.py

@@ -12,7 +12,7 @@ with open("README.md", "r") as fh:
 # This call to setup() does all the work
 setup(
     name="meshtastic",
-    version="1.2.58",
+    version="1.2.75",
     description="Python API & client shell for talking to Meshtastic devices",
     long_description=long_description,
     long_description_content_type="text/markdown",

standalone_readme.txt

@@ -0,0 +1,7 @@
+readme.txt for single standalone executable zip files that can be
+downloaded from https://github.com/meshtastic/Meshtastic-python/releases
+
+If you do not want to install python and/or the python libraries, you can download one of these
+zip files to run the Meshtastic command line interface (CLI) as a standalone executable.
+
+See https://meshtastic.org/docs/software/python/python-standalone for more info.