riberry-robot


Nameriberry-robot JSON
Version 0.0.1 PyPI version JSON
download
home_pageNone
SummaryRiberry: Robot Intelligent Binary Enhancement Resource Revolutionary Yield
upload_time2024-10-15 05:20:47
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseCopyright (c) 2024 Iori Yanokura. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords riberry robotics automation robot module
VCS
bugtrack_url
requirements Adafruit-Blinka RPi.GPIO adafruit-circuitpython-mprls colorama filelock i2c-for-esp32 pybsc smbus2
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Riberry: Robot Intelligent Binary Enhancement Resource Revolutionary Yield

## Install Riberry

### For radxa

After cloning this repository into your catkin workspace, build it:

```
catkin build riberry_startup
```

After sourcing, install the systemd-related programs with the following commands:

```
sudo ./install.py
sudo reboot
```

You can use the dry-run option to see which scripts will be installed without actually installing them:

```
./install.py --dry-run
```

### For atom s3 and atom echo

Please write the programs found under the [firmware](https://github.com/iory/riberry/tree/master/firmware) section into the atom s3 and atom echo to display the IP and capture audio.


### Atom S3 Display

#### Additional Information

You can use ROS to publish additional information to your Atom S3 display. The following script demonstrates how to publish a message with color formatting using the `colorama` library:


```
import rospy
from std_msgs.msg import String
from colorama import Back

rospy.init_node('publisher', anonymous=True)
pub = rospy.Publisher('/atom_s3_additional_info', String, queue_size=10)
rospy.sleep(1)  # Ensure the publisher is properly set up

message = String()
message.data = Back.RED + "Test\nprint\n" + Back.RESET
pub.publish(message)
rospy.loginfo("Message published")
```

This script sets up a ROS publisher node that sends a message to the `/atom_s3_additional_info` topic.
The message text is colored red using colorama. By using ROS and colorama, you can easily publish and display colored messages on your Atom S3 display.

<img src="doc/atoms3-additional-info.jpg" alt="Display additional message with Atom S3" width="300">

#### Displaying Images on Atom S3

You can also display images on your Atom S3 by setting a ROS parameter.
To display an image, you need to set the `/display_image` parameter to the desired image topic. For example:

```
rosparam set /display_image "/camera/color/image_raw"
```

This command sets the `/display_image` parameter to the `/camera/color/image_raw` topic, which will then be displayed on the Atom S3.

To revert back to the normal display (i.e., stop displaying the image), you can reset the `/display_image` parameter to an empty string:

```
rosparam set /display_image ""
```

By managing the `/display_image` parameter, you can control when and which images are displayed on your Atom S3.

##### Button States for `/atom_s3_button_state` Topic

The `/atom_s3_button_state` topic publishes messages of type `std_msgs/Int32`. The value corresponds to different button states as shown in the table below:


| Button State        | Value   |
|---------------------|---------|
| Not Changed         | 0       |
| Clicked 1-10 Times  | 1-10    |
| Long Pressed        | 11      |
| Released            | 12      |
| Reset               | 13      |

## Distribute radxa image as SD card

When distributing images, it's necessary to adjust the disk size among other parameters initially due to writing to an SD card.
The `resize-helper.service` is a tool designed for this purpose. To enable this, please use the `--enable-oneshot` option to activate these settings.
Additionally, the `change-hostname-helper.service`, which randomly changes the hostname, will also be enabled.

Run the following command just before making SD cards for distribution:

```
sudo ./install.py --enable-oneshot
```

If you are concerned about the security of the network:
```
# sudo rm -f /etc/NetworkManager/system-connections/*
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "riberry-robot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "riberry, robotics, automation, robot module",
    "author": null,
    "author_email": "Iori Yanokura <yanokura@jsk.imi.i.u-tokyo.ac.jp>, Naoya Yamaguchi <yamaguchi@jsk.imi.i.u-tokyo.ac.jp>, Aoi Nakane <nakane@jsk.imi.i.u-tokyo.ac.jp>",
    "download_url": "https://files.pythonhosted.org/packages/7b/bf/01e31510beb4b6a72139bb064ff72ea8b616f7b1fc9b73f679513c32585e/riberry_robot-0.0.1.tar.gz",
    "platform": null,
    "description": "# Riberry: Robot Intelligent Binary Enhancement Resource Revolutionary Yield\n\n## Install Riberry\n\n### For radxa\n\nAfter cloning this repository into your catkin workspace, build it:\n\n```\ncatkin build riberry_startup\n```\n\nAfter sourcing, install the systemd-related programs with the following commands:\n\n```\nsudo ./install.py\nsudo reboot\n```\n\nYou can use the dry-run option to see which scripts will be installed without actually installing them:\n\n```\n./install.py --dry-run\n```\n\n### For atom s3 and atom echo\n\nPlease write the programs found under the [firmware](https://github.com/iory/riberry/tree/master/firmware) section into the atom s3 and atom echo to display the IP and capture audio.\n\n\n### Atom S3 Display\n\n#### Additional Information\n\nYou can use ROS to publish additional information to your Atom S3 display. The following script demonstrates how to publish a message with color formatting using the `colorama` library:\n\n\n```\nimport rospy\nfrom std_msgs.msg import String\nfrom colorama import Back\n\nrospy.init_node('publisher', anonymous=True)\npub = rospy.Publisher('/atom_s3_additional_info', String, queue_size=10)\nrospy.sleep(1)  # Ensure the publisher is properly set up\n\nmessage = String()\nmessage.data = Back.RED + \"Test\\nprint\\n\" + Back.RESET\npub.publish(message)\nrospy.loginfo(\"Message published\")\n```\n\nThis script sets up a ROS publisher node that sends a message to the `/atom_s3_additional_info` topic.\nThe message text is colored red using colorama. By using ROS and colorama, you can easily publish and display colored messages on your Atom S3 display.\n\n<img src=\"doc/atoms3-additional-info.jpg\" alt=\"Display additional message with Atom S3\" width=\"300\">\n\n#### Displaying Images on Atom S3\n\nYou can also display images on your Atom S3 by setting a ROS parameter.\nTo display an image, you need to set the `/display_image` parameter to the desired image topic. For example:\n\n```\nrosparam set /display_image \"/camera/color/image_raw\"\n```\n\nThis command sets the `/display_image` parameter to the `/camera/color/image_raw` topic, which will then be displayed on the Atom S3.\n\nTo revert back to the normal display (i.e., stop displaying the image), you can reset the `/display_image` parameter to an empty string:\n\n```\nrosparam set /display_image \"\"\n```\n\nBy managing the `/display_image` parameter, you can control when and which images are displayed on your Atom S3.\n\n##### Button States for `/atom_s3_button_state` Topic\n\nThe `/atom_s3_button_state` topic publishes messages of type `std_msgs/Int32`. The value corresponds to different button states as shown in the table below:\n\n\n| Button State        | Value   |\n|---------------------|---------|\n| Not Changed         | 0       |\n| Clicked 1-10 Times  | 1-10    |\n| Long Pressed        | 11      |\n| Released            | 12      |\n| Reset               | 13      |\n\n## Distribute radxa image as SD card\n\nWhen distributing images, it's necessary to adjust the disk size among other parameters initially due to writing to an SD card.\nThe `resize-helper.service` is a tool designed for this purpose. To enable this, please use the `--enable-oneshot` option to activate these settings.\nAdditionally, the `change-hostname-helper.service`, which randomly changes the hostname, will also be enabled.\n\nRun the following command just before making SD cards for distribution:\n\n```\nsudo ./install.py --enable-oneshot\n```\n\nIf you are concerned about the security of the network:\n```\n# sudo rm -f /etc/NetworkManager/system-connections/*\n```\n",
    "bugtrack_url": null,
    "license": "Copyright (c) 2024 Iori Yanokura.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Riberry: Robot Intelligent Binary Enhancement Resource Revolutionary Yield",
    "version": "0.0.1",
    "project_urls": {
        "Homepage": "https://github.com/iory/riberry",
        "Repository": "https://github.com/iory/riberry"
    },
    "split_keywords": [
        "riberry",
        " robotics",
        " automation",
        " robot module"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "48510c39102d021b9cca07a3d4d0eeb918e70df6b099c2df5cd9be79408e12e7",
                "md5": "78b4e169732efebb479a5f207625785a",
                "sha256": "f6a08657699967a8d52310e7642a4ee035fcb9ff5fcfb08458e354b59812932a"
            },
            "downloads": -1,
            "filename": "riberry_robot-0.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "78b4e169732efebb479a5f207625785a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4524,
            "upload_time": "2024-10-15T05:20:46",
            "upload_time_iso_8601": "2024-10-15T05:20:46.232745Z",
            "url": "https://files.pythonhosted.org/packages/48/51/0c39102d021b9cca07a3d4d0eeb918e70df6b099c2df5cd9be79408e12e7/riberry_robot-0.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7bbf01e31510beb4b6a72139bb064ff72ea8b616f7b1fc9b73f679513c32585e",
                "md5": "494f70f4ce0a52fb3104142b5b57e725",
                "sha256": "818d0f78b2d2fbd5648c965182d3185a8d58848604b7cade758b7be5509a5286"
            },
            "downloads": -1,
            "filename": "riberry_robot-0.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "494f70f4ce0a52fb3104142b5b57e725",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3790,
            "upload_time": "2024-10-15T05:20:47",
            "upload_time_iso_8601": "2024-10-15T05:20:47.321318Z",
            "url": "https://files.pythonhosted.org/packages/7b/bf/01e31510beb4b6a72139bb064ff72ea8b616f7b1fc9b73f679513c32585e/riberry_robot-0.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-15 05:20:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "iory",
    "github_project": "riberry",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "RPi.GPIO",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-mprls",
            "specs": []
        },
        {
            "name": "colorama",
            "specs": []
        },
        {
            "name": "filelock",
            "specs": []
        },
        {
            "name": "i2c-for-esp32",
            "specs": []
        },
        {
            "name": "pybsc",
            "specs": []
        },
        {
            "name": "smbus2",
            "specs": []
        }
    ],
    "lcname": "riberry-robot"
}
        
Elapsed time: 0.48599s